From d0f783c3dd120fbf67165417d774387cfcbb3401 Mon Sep 17 00:00:00 2001 From: Noah Stanford Date: Wed, 5 Jan 2022 15:01:24 -0500 Subject: Replace tabbed indents with 4 spaces --- .../android/grafika/gles/OffscreenSurfaceTest.java | 166 ++--- .../java/com/smartdevicelink/test/Validator.java | 4 +- .../datatypes/VideoStreamingCapabilityTests.java | 8 +- .../transport/TransportBrokerTest.java | 2 +- .../transport/RouterServiceValidator.java | 4 +- .../transport/SdlRouterService.java | 28 +- .../lifecycle/BaseSystemCapabilityManager.java | 12 +- .../protocol/enums/MessageType.java | 8 +- .../com/smartdevicelink/proxy/rpc/AddCommand.java | 68 +- .../com/smartdevicelink/proxy/rpc/AddSubMenu.java | 102 +-- .../smartdevicelink/proxy/rpc/AirbagStatus.java | 110 +-- .../java/com/smartdevicelink/proxy/rpc/Alert.java | 156 ++-- .../proxy/rpc/AudioPassThruCapabilities.java | 54 +- .../com/smartdevicelink/proxy/rpc/BeltStatus.java | 192 ++--- .../smartdevicelink/proxy/rpc/BodyInformation.java | 210 +++--- .../proxy/rpc/ButtonCapabilities.java | 62 +- .../proxy/rpc/ChangeRegistration.java | 100 +-- .../java/com/smartdevicelink/proxy/rpc/Choice.java | 66 +- .../proxy/rpc/ClusterModeStatus.java | 58 +- .../proxy/rpc/CreateInteractionChoiceSet.java | 50 +- .../com/smartdevicelink/proxy/rpc/DIDResult.java | 48 +- .../java/com/smartdevicelink/proxy/rpc/DTC.java | 32 +- .../smartdevicelink/proxy/rpc/DeleteCommand.java | 38 +- .../com/smartdevicelink/proxy/rpc/DeleteFile.java | 38 +- .../proxy/rpc/DeleteInteractionChoiceSet.java | 38 +- .../smartdevicelink/proxy/rpc/DeleteSubMenu.java | 36 +- .../com/smartdevicelink/proxy/rpc/DeviceInfo.java | 84 +-- .../smartdevicelink/proxy/rpc/DeviceStatus.java | 166 ++--- .../proxy/rpc/DiagnosticMessage.java | 52 +- .../proxy/rpc/DisplayCapabilities.java | 80 +- .../com/smartdevicelink/proxy/rpc/ECallInfo.java | 56 +- .../smartdevicelink/proxy/rpc/EmergencyEvent.java | 96 +-- .../com/smartdevicelink/proxy/rpc/GPSData.java | 258 +++---- .../smartdevicelink/proxy/rpc/GenericResponse.java | 56 +- .../com/smartdevicelink/proxy/rpc/GetDTCs.java | 36 +- .../smartdevicelink/proxy/rpc/GetVehicleData.java | 306 ++++---- .../smartdevicelink/proxy/rpc/HMIPermissions.java | 56 +- .../java/com/smartdevicelink/proxy/rpc/Image.java | 46 +- .../com/smartdevicelink/proxy/rpc/ImageField.java | 48 +- .../smartdevicelink/proxy/rpc/ImageResolution.java | 36 +- .../proxy/rpc/KeyboardProperties.java | 138 ++-- .../com/smartdevicelink/proxy/rpc/MenuParams.java | 112 +-- .../java/com/smartdevicelink/proxy/rpc/MyKey.java | 24 +- .../smartdevicelink/proxy/rpc/OnHashChange.java | 24 +- .../smartdevicelink/proxy/rpc/OnKeyboardInput.java | 36 +- .../smartdevicelink/proxy/rpc/OnSystemRequest.java | 98 +-- .../smartdevicelink/proxy/rpc/OnTouchEvent.java | 34 +- .../smartdevicelink/proxy/rpc/OnVehicleData.java | 396 +++++----- .../proxy/rpc/ParameterPermissions.java | 60 +- .../proxy/rpc/PerformAudioPassThru.java | 96 +-- .../proxy/rpc/PerformInteraction.java | 154 ++-- .../smartdevicelink/proxy/rpc/PermissionItem.java | 56 +- .../proxy/rpc/PresetBankCapabilities.java | 26 +- .../com/smartdevicelink/proxy/rpc/PutFile.java | 156 ++-- .../com/smartdevicelink/proxy/rpc/RGBColor.java | 56 +- .../com/smartdevicelink/proxy/rpc/ReadDID.java | 58 +- .../proxy/rpc/RegisterAppInterface.java | 240 +++--- .../proxy/rpc/ResetGlobalProperties.java | 44 +- .../smartdevicelink/proxy/rpc/ScreenParams.java | 42 +- .../proxy/rpc/ScrollableMessage.java | 84 +-- .../smartdevicelink/proxy/rpc/SdlMsgVersion.java | 56 +- .../com/smartdevicelink/proxy/rpc/SetAppIcon.java | 32 +- .../proxy/rpc/SetDisplayLayout.java | 52 +- .../proxy/rpc/SetGlobalProperties.java | 128 ++-- .../proxy/rpc/SetMediaClockTimer.java | 80 +- .../java/com/smartdevicelink/proxy/rpc/Show.java | 210 +++--- .../proxy/rpc/SingleTireStatus.java | 56 +- .../java/com/smartdevicelink/proxy/rpc/Slider.java | 118 +-- .../com/smartdevicelink/proxy/rpc/SoftButton.java | 84 +-- .../proxy/rpc/SoftButtonCapabilities.java | 74 +- .../java/com/smartdevicelink/proxy/rpc/Speak.java | 46 +- .../com/smartdevicelink/proxy/rpc/StartTime.java | 50 +- .../smartdevicelink/proxy/rpc/SubscribeButton.java | 24 +- .../proxy/rpc/SubscribeVehicleData.java | 424 +++++------ .../smartdevicelink/proxy/rpc/SystemRequest.java | 48 +- .../com/smartdevicelink/proxy/rpc/TTSChunk.java | 36 +- .../proxy/rpc/TemplateColorScheme.java | 56 +- .../com/smartdevicelink/proxy/rpc/TextField.java | 80 +- .../com/smartdevicelink/proxy/rpc/TouchCoord.java | 36 +- .../com/smartdevicelink/proxy/rpc/TouchEvent.java | 50 +- .../proxy/rpc/TouchEventCapabilities.java | 46 +- .../proxy/rpc/UnsubscribeButton.java | 28 +- .../proxy/rpc/UnsubscribeVehicleData.java | 414 +++++------ .../proxy/rpc/VehicleDataResult.java | 42 +- .../com/smartdevicelink/proxy/rpc/VehicleType.java | 92 +-- .../com/smartdevicelink/proxy/rpc/VrHelpItem.java | 56 +- .../proxy/rpc/enums/SystemCapabilityType.java | 818 ++++++++++----------- .../streaming/video/VideoStreamingParameters.java | 28 +- .../java/com/smartdevicelink/transport/SdlPsm.java | 10 +- .../smartdevicelink/transport/SiphonServer.java | 2 +- 90 files changed, 4138 insertions(+), 4138 deletions(-) diff --git a/android/sdl_android/src/androidTest/java/com/android/grafika/gles/OffscreenSurfaceTest.java b/android/sdl_android/src/androidTest/java/com/android/grafika/gles/OffscreenSurfaceTest.java index 2f93c8307..425f23f9c 100644 --- a/android/sdl_android/src/androidTest/java/com/android/grafika/gles/OffscreenSurfaceTest.java +++ b/android/sdl_android/src/androidTest/java/com/android/grafika/gles/OffscreenSurfaceTest.java @@ -18,88 +18,88 @@ import static junit.framework.TestCase.assertTrue; @RunWith(AndroidJUnit4.class) public class OffscreenSurfaceTest { - private final String TAG = OffscreenSurfaceTest.class.getSimpleName(); - private final int mWidth = 1280; - private final int mHeight = 720; - private final int mIterations = 100; - - @Test - public void testReadPixels() { - EglCore eglCore = new EglCore(null, 0); - OffscreenSurface offscreenSurface = new OffscreenSurface(eglCore, mWidth, mHeight); - float time = runReadPixelsTest(offscreenSurface); - Log.d(TAG, "runReadPixelsTest returns " + time + " msec"); - } - - // HELPER test method - /** - * Does a simple bit of rendering and then reads the pixels back. - * - * @return total time (msec order) spent on glReadPixels() - */ - private float runReadPixelsTest(OffscreenSurface eglSurface) { - long totalTime = 0; - - eglSurface.makeCurrent(); - - ByteBuffer pixelBuf = ByteBuffer.allocateDirect(mWidth * mHeight * 4); - pixelBuf.order(ByteOrder.LITTLE_ENDIAN); - - Log.d(TAG, "Running..."); - float colorMult = 1.0f / mIterations; - for (int i = 0; i < mIterations; i++) { - if ((i % (mIterations / 8)) == 0) { - Log.d(TAG, "iteration " + i); - } - - // Clear the screen to a solid color, then add a rectangle. Change the color - // each time. - float r = i * colorMult; - float g = 1.0f - r; - float b = (r + g) / 2.0f; - GLES20.glClearColor(r, g, b, 1.0f); - GLES20.glClear(GLES20.GL_COLOR_BUFFER_BIT); - - GLES20.glEnable(GLES20.GL_SCISSOR_TEST); - GLES20.glScissor(mWidth / 4, mHeight / 4, mWidth / 2, mHeight / 2); - GLES20.glClearColor(b, g, r, 1.0f); - GLES20.glClear(GLES20.GL_COLOR_BUFFER_BIT); - GLES20.glDisable(GLES20.GL_SCISSOR_TEST); - - // Try to ensure that rendering has finished. - GLES20.glFinish(); - GLES20.glReadPixels(0, 0, 1, 1, - GLES20.GL_RGBA, GLES20.GL_UNSIGNED_BYTE, pixelBuf); - - // Time individual extraction. Ideally we'd be timing a bunch of these calls - // and measuring the aggregate time, but we want the isolated time, and if we - // just read the same buffer repeatedly we might get some sort of cache effect. - long startWhen = System.nanoTime(); - GLES20.glReadPixels(0, 0, mWidth, mHeight, - GLES20.GL_RGBA, GLES20.GL_UNSIGNED_BYTE, pixelBuf); - totalTime += System.nanoTime() - startWhen; - } - Log.d(TAG, "done"); - - // It's not the good idea to request external strage permission in unit test. - boolean requireStoragePermission = false; - if (requireStoragePermission) { - long startWhen = System.nanoTime(); - File file = new File(Environment.getExternalStorageDirectory(), - "test.png"); - try { - eglSurface.saveFrame(file); - } catch (IOException ioe) { - throw new RuntimeException(ioe); - } - Log.d(TAG, "Saved frame in " + ((System.nanoTime() - startWhen) / 1000000) + "ms"); - assertTrue(file.exists()); - } else { - // here' we can recognize Unit Test succeeded, but anyway checks to see totalTime and buffer capacity. - assertTrue(pixelBuf.capacity() > 0 && totalTime > 0); - } - - return (float)totalTime / 1000000f; - } + private final String TAG = OffscreenSurfaceTest.class.getSimpleName(); + private final int mWidth = 1280; + private final int mHeight = 720; + private final int mIterations = 100; + + @Test + public void testReadPixels() { + EglCore eglCore = new EglCore(null, 0); + OffscreenSurface offscreenSurface = new OffscreenSurface(eglCore, mWidth, mHeight); + float time = runReadPixelsTest(offscreenSurface); + Log.d(TAG, "runReadPixelsTest returns " + time + " msec"); + } + + // HELPER test method + /** + * Does a simple bit of rendering and then reads the pixels back. + * + * @return total time (msec order) spent on glReadPixels() + */ + private float runReadPixelsTest(OffscreenSurface eglSurface) { + long totalTime = 0; + + eglSurface.makeCurrent(); + + ByteBuffer pixelBuf = ByteBuffer.allocateDirect(mWidth * mHeight * 4); + pixelBuf.order(ByteOrder.LITTLE_ENDIAN); + + Log.d(TAG, "Running..."); + float colorMult = 1.0f / mIterations; + for (int i = 0; i < mIterations; i++) { + if ((i % (mIterations / 8)) == 0) { + Log.d(TAG, "iteration " + i); + } + + // Clear the screen to a solid color, then add a rectangle. Change the color + // each time. + float r = i * colorMult; + float g = 1.0f - r; + float b = (r + g) / 2.0f; + GLES20.glClearColor(r, g, b, 1.0f); + GLES20.glClear(GLES20.GL_COLOR_BUFFER_BIT); + + GLES20.glEnable(GLES20.GL_SCISSOR_TEST); + GLES20.glScissor(mWidth / 4, mHeight / 4, mWidth / 2, mHeight / 2); + GLES20.glClearColor(b, g, r, 1.0f); + GLES20.glClear(GLES20.GL_COLOR_BUFFER_BIT); + GLES20.glDisable(GLES20.GL_SCISSOR_TEST); + + // Try to ensure that rendering has finished. + GLES20.glFinish(); + GLES20.glReadPixels(0, 0, 1, 1, + GLES20.GL_RGBA, GLES20.GL_UNSIGNED_BYTE, pixelBuf); + + // Time individual extraction. Ideally we'd be timing a bunch of these calls + // and measuring the aggregate time, but we want the isolated time, and if we + // just read the same buffer repeatedly we might get some sort of cache effect. + long startWhen = System.nanoTime(); + GLES20.glReadPixels(0, 0, mWidth, mHeight, + GLES20.GL_RGBA, GLES20.GL_UNSIGNED_BYTE, pixelBuf); + totalTime += System.nanoTime() - startWhen; + } + Log.d(TAG, "done"); + + // It's not the good idea to request external strage permission in unit test. + boolean requireStoragePermission = false; + if (requireStoragePermission) { + long startWhen = System.nanoTime(); + File file = new File(Environment.getExternalStorageDirectory(), + "test.png"); + try { + eglSurface.saveFrame(file); + } catch (IOException ioe) { + throw new RuntimeException(ioe); + } + Log.d(TAG, "Saved frame in " + ((System.nanoTime() - startWhen) / 1000000) + "ms"); + assertTrue(file.exists()); + } else { + // here' we can recognize Unit Test succeeded, but anyway checks to see totalTime and buffer capacity. + assertTrue(pixelBuf.capacity() > 0 && totalTime > 0); + } + + return (float)totalTime / 1000000f; + } } diff --git a/android/sdl_android/src/androidTest/java/com/smartdevicelink/test/Validator.java b/android/sdl_android/src/androidTest/java/com/smartdevicelink/test/Validator.java index 094b29794..235a9dfff 100644 --- a/android/sdl_android/src/androidTest/java/com/smartdevicelink/test/Validator.java +++ b/android/sdl_android/src/androidTest/java/com/smartdevicelink/test/Validator.java @@ -2431,7 +2431,7 @@ public class Validator { log("validatePermissionItem", "Items are the same object. No defensive copy took place."); return false; } - */ + */ if (!item1.getRpcName().equals(item2.getRpcName())) { return false; } @@ -2509,7 +2509,7 @@ public class Validator { log("validateParameterPermissions", "Items are the same object. No defensive copy took place."); return false; } - */ + */ if (!validateStringList(item1.getAllowed(), item2.getAllowed())) { return false; } diff --git a/android/sdl_android/src/androidTest/java/com/smartdevicelink/test/rpc/datatypes/VideoStreamingCapabilityTests.java b/android/sdl_android/src/androidTest/java/com/smartdevicelink/test/rpc/datatypes/VideoStreamingCapabilityTests.java index c13199223..719d8a3a0 100644 --- a/android/sdl_android/src/androidTest/java/com/smartdevicelink/test/rpc/datatypes/VideoStreamingCapabilityTests.java +++ b/android/sdl_android/src/androidTest/java/com/smartdevicelink/test/rpc/datatypes/VideoStreamingCapabilityTests.java @@ -35,7 +35,7 @@ public class VideoStreamingCapabilityTests extends TestCase { msg.setPixelPerInch(TestValues.GENERAL_DOUBLE); msg.setScale(TestValues.GENERAL_DOUBLE); msg.setAdditionalVideoStreamingCapabilities(TestValues.GENERAL_ADDITIONAL_CAPABILITY_LIST); - msg.setPreferredFPS(TestValues.GENERAL_INTEGER); + msg.setPreferredFPS(TestValues.GENERAL_INTEGER); } /** @@ -51,7 +51,7 @@ public class VideoStreamingCapabilityTests extends TestCase { Double pixelPerInch = msg.getPixelPerInch(); Double scale = msg.getScale(); List additionalVideoStreamingCapabilities = msg.getAdditionalVideoStreamingCapabilities(); - Integer preferredFPS = msg.getPreferredFPS(); + Integer preferredFPS = msg.getPreferredFPS(); // Valid Tests assertEquals(TestValues.MATCH, (List) TestValues.GENERAL_VIDEOSTREAMINGFORMAT_LIST, format); @@ -75,7 +75,7 @@ public class VideoStreamingCapabilityTests extends TestCase { assertNull(TestValues.NULL, msg.getPixelPerInch()); assertNull(TestValues.NULL, msg.getScale()); assertNull(TestValues.NULL, msg.getAdditionalVideoStreamingCapabilities()); - assertNull(TestValues.NULL, msg.getPreferredFPS()); + assertNull(TestValues.NULL, msg.getPreferredFPS()); } public void testJson() { @@ -90,7 +90,7 @@ public class VideoStreamingCapabilityTests extends TestCase { reference.put(VideoStreamingCapability.KEY_DIAGONAL_SCREEN_SIZE, TestValues.GENERAL_DOUBLE); reference.put(VideoStreamingCapability.KEY_PIXEL_PER_INCH, TestValues.GENERAL_DOUBLE); reference.put(VideoStreamingCapability.KEY_SCALE, TestValues.GENERAL_DOUBLE); - reference.put(VideoStreamingCapability.KEY_PREFERRED_FPS, TestValues.GENERAL_INTEGER); + reference.put(VideoStreamingCapability.KEY_PREFERRED_FPS, TestValues.GENERAL_INTEGER); JSONObject underTest = msg.serializeJSON(); assertEquals(TestValues.MATCH, reference.length(), underTest.length()); diff --git a/android/sdl_android/src/androidTest/java/com/smartdevicelink/transport/TransportBrokerTest.java b/android/sdl_android/src/androidTest/java/com/smartdevicelink/transport/TransportBrokerTest.java index 977bb3020..e06efda8e 100644 --- a/android/sdl_android/src/androidTest/java/com/smartdevicelink/transport/TransportBrokerTest.java +++ b/android/sdl_android/src/androidTest/java/com/smartdevicelink/transport/TransportBrokerTest.java @@ -24,7 +24,7 @@ import static junit.framework.TestCase.assertTrue; @RunWith(AndroidJUnit4.class) public class TransportBrokerTest { //FIXME this test class needs to be fixed. At this point these tests are not helpful RouterServiceValidator rsvp; - // public TransportBrokerThread(Context context, String appId, ComponentName service){ + // public TransportBrokerThread(Context context, String appId, ComponentName service){ @Before public void setUp() throws Exception { diff --git a/android/sdl_android/src/main/java/com/smartdevicelink/transport/RouterServiceValidator.java b/android/sdl_android/src/main/java/com/smartdevicelink/transport/RouterServiceValidator.java index e29ebf1d3..2df937b58 100644 --- a/android/sdl_android/src/main/java/com/smartdevicelink/transport/RouterServiceValidator.java +++ b/android/sdl_android/src/main/java/com/smartdevicelink/transport/RouterServiceValidator.java @@ -233,8 +233,8 @@ public class RouterServiceValidator { * @param context */ //private void retrieveBestRouterServiceName(Context context) { - // FindRouterTask task = new FindRouterTask(null); - // task.execute(context); + // FindRouterTask task = new FindRouterTask(null); + // task.execute(context); //} /** diff --git a/android/sdl_android/src/main/java/com/smartdevicelink/transport/SdlRouterService.java b/android/sdl_android/src/main/java/com/smartdevicelink/transport/SdlRouterService.java index 4be83a7bc..030259bd8 100644 --- a/android/sdl_android/src/main/java/com/smartdevicelink/transport/SdlRouterService.java +++ b/android/sdl_android/src/main/java/com/smartdevicelink/transport/SdlRouterService.java @@ -1692,9 +1692,9 @@ public class SdlRouterService extends Service { } /** - * 1. If the app has SDL shut off, shut down - * 2. if The app has an Alt Transport address or was started by one, stay open - * 3. If Bluetooth is off/NA shut down + * 1. If the app has SDL shut off, shut down + * 2. if The app has an Alt Transport address or was started by one, stay open + * 3. If Bluetooth is off/NA shut down * 4. Anything else */ public boolean shouldServiceRemainOpen(Intent intent) { @@ -2743,8 +2743,8 @@ public class SdlRouterService extends Service { } /* **************************************************************************************************************************************** - // *********************************************************** LEGACY **************************************************************** - //*****************************************************************************************************************************************/ + // *********************************************************** LEGACY **************************************************************** + //*****************************************************************************************************************************************/ private boolean legacyModeEnabled = false; private void enableLegacyMode(boolean enable) { @@ -2761,9 +2761,9 @@ public class SdlRouterService extends Service { } - /* **************************************************************************************************************************************** - // *********************************************************** UTILITY **************************************************************** - //*****************************************************************************************************************************************/ + /* **************************************************************************************************************************************** + // *********************************************************** UTILITY **************************************************************** + //*****************************************************************************************************************************************/ private void debugPacket(byte[] bytes) { //DEBUG @@ -2942,9 +2942,9 @@ public class SdlRouterService extends Service { pingIntent = null; } - /* **************************************************************************************************************************************** - // ********************************************************** TINY CLASSES ************************************************************ - //*****************************************************************************************************************************************/ + /* **************************************************************************************************************************************** + // ********************************************************** TINY CLASSES ************************************************************ + //*****************************************************************************************************************************************/ /** * This class enables us to compare two router services @@ -3138,9 +3138,9 @@ public class SdlRouterService extends Service { return appId; } - /*public long getAppId() { - return appId; - }*/ + /*public long getAppId() { + return appId; + }*/ /** * This is a convenience variable and may not be used or useful in different protocols diff --git a/base/src/main/java/com/smartdevicelink/managers/lifecycle/BaseSystemCapabilityManager.java b/base/src/main/java/com/smartdevicelink/managers/lifecycle/BaseSystemCapabilityManager.java index 33a778e58..1f6c663a8 100644 --- a/base/src/main/java/com/smartdevicelink/managers/lifecycle/BaseSystemCapabilityManager.java +++ b/base/src/main/java/com/smartdevicelink/managers/lifecycle/BaseSystemCapabilityManager.java @@ -590,12 +590,12 @@ abstract class BaseSystemCapabilityManager { final GetSystemCapability request = new GetSystemCapability(); request.setSystemCapabilityType(systemCapabilityType); - /* - The subscription flag in the request should be set based on multiple variables: - - if subscribe is null (no change), willSubscribe = current subscription status, or false if the HU does not support subscriptions - - if subscribe is false, then willSubscribe = false - - if subscribe is true and the HU supports subscriptions, then willSubscribe = true - */ + /* + The subscription flag in the request should be set based on multiple variables: + - if subscribe is null (no change), willSubscribe = current subscription status, or false if the HU does not support subscriptions + - if subscribe is false, then willSubscribe = false + - if subscribe is true and the HU supports subscriptions, then willSubscribe = true + */ boolean shouldSubscribe = (subscribe != null) ? subscribe : isSubscribedToSystemCapability(systemCapabilityType); final boolean willSubscribe = shouldSubscribe && supportsSubscriptions(); request.setSubscribe(willSubscribe); diff --git a/base/src/main/java/com/smartdevicelink/protocol/enums/MessageType.java b/base/src/main/java/com/smartdevicelink/protocol/enums/MessageType.java index 9e7defe79..f880e1e69 100644 --- a/base/src/main/java/com/smartdevicelink/protocol/enums/MessageType.java +++ b/base/src/main/java/com/smartdevicelink/protocol/enums/MessageType.java @@ -33,10 +33,10 @@ package com.smartdevicelink.protocol.enums; public enum MessageType { - // START_SESSION, -// START_SESSION_ACK, -// START_SESSION_NACK, -// END_SESSION, + // START_SESSION, +// START_SESSION_ACK, +// START_SESSION_NACK, +// END_SESSION, UNDEFINED, BULK, RPC; diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/AddCommand.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/AddCommand.java index 3458e361a..d2a68ff74 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/AddCommand.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/AddCommand.java @@ -69,45 +69,45 @@ import java.util.List; * *

Parameter List

* - * - * - * - * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * + * + * + * + * + * + * * - * - * - * - * + * + * + * + * * * * diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/AddSubMenu.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/AddSubMenu.java index 93c5f0719..f1c1c7ecf 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/AddSubMenu.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/AddSubMenu.java @@ -50,62 +50,62 @@ import java.util.Hashtable; * *

Parameter List

*
Param NameTypeDescription
Param NameTypeDescription Req.NotesVersion Available
cmdID Integerunique ID of the command to addNotesVersion Available
cmdID Integerunique ID of the command to addY minvalue:0; maxvalue:2000000000SmartDeviceLink 1.0
menuParamsButtonNameName of the button to unsubscribe. minvalue:0; maxvalue:2000000000SmartDeviceLink 1.0
menuParamsButtonNameName of the button to unsubscribe.YSmartDeviceLink 1.0
vrCommandsString

An array of strings to be used as VR synonyms for this command.

If this array is provided, it may not be empty.

SmartDeviceLink 1.0
vrCommandsString

An array of strings to be used as VR synonyms for this command.

If this array is provided, it may not be empty.

Nminsize:1; maxsize:100SmartDeviceLink 1.0
cmdIconImage

Image struct determining whether static or dynamic icon.

If omitted on supported displays, no (or the default if applicable) icon shall be displayed.

minsize:1; maxsize:100SmartDeviceLink 1.0
cmdIconImage

Image struct determining whether static or dynamic icon.

If omitted on supported displays, no (or the default if applicable) icon shall be displayed.

NSmartDeviceLink 1.0
SmartDeviceLink 1.0
secondaryImageImageOptional secondary image struct for menu cell
- * - * - * - * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * * * * diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/AirbagStatus.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/AirbagStatus.java index 34930fe4d..5f037bb3d 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/AirbagStatus.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/AirbagStatus.java @@ -45,60 +45,60 @@ import java.util.Hashtable; * *

Parameter List

*
Param NameTypeDescription
Param NameTypeDescription Req.NotesVersion Available
menuIDIntegerUnique ID that identifies this sub menu. This value is used in AddCommand to which SubMenu is the parent of the command being added.NotesVersion Available
menuIDIntegerUnique ID that identifies this sub menu. This value is used in AddCommand to which SubMenu is the parent of the command being added.YSmartDeviceLink 1.0
positionIntegerPosition within the items of the top level Command Menu. 0 will insert at the front, 1 will insert after the first existing element, etc. Position of any submenu will always be located before the return and exit options.SmartDeviceLink 1.0
positionIntegerPosition within the items of the top level Command Menu. 0 will insert at the front, 1 will insert after the first existing element, etc. Position of any submenu will always be located before the return and exit options.NMin Value: 0

Max Value: 1000

If position is greater or equal than the number of items on top level, the sub menu will be appended by the end.

If this parameter is omitted, the entry will be added at the end of the list.

SmartDeviceLink 1.0
menuNameStringText which is displayed representing this submenu itemMin Value: 0

Max Value: 1000

If position is greater or equal than the number of items on top level, the sub menu will be appended by the end.

If this parameter is omitted, the entry will be added at the end of the list.

SmartDeviceLink 1.0
menuNameStringText which is displayed representing this submenu itemYmaxlength:500SmartDeviceLink 1.0
menuIconImageImage to be be shown along with the submenu itemmaxlength:500SmartDeviceLink 1.0
menuIconImageImage to be be shown along with the submenu itemNSmartDeviceLink 5.0
menuLayoutMenuLayoutSets the layout of the submenu screen.SmartDeviceLink 6.0
parentIDIntegerunique ID of the sub menu, the command will be added to. If not provided or 0, it will be provided to the top level of the in application menu.NMin Value: 0

Max Value: 2000000000

SmartDeviceLink 7.0.0
SmartDeviceLink 5.0
menuLayoutMenuLayoutSets the layout of the submenu screen.SmartDeviceLink 6.0
parentIDIntegerunique ID of the sub menu, the command will be added to. If not provided or 0, it will be provided to the top level of the in application menu.NMin Value: 0

Max Value: 2000000000

SmartDeviceLink 7.0.0
secondaryTextString
- * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * * *
NameTypeDescriptionSmartDeviceLink Version.
driverAirbagDeployed VehicleDataEventStatusStatus of driver airbag.SmartDeviceLink 1.0
driverSideAirbagDeployedVehicleDataEventStatusStatus of driver side airbag.SmartDeviceLink 1.0
driverCurtainAirbagDeployedVehicleDataEventStatusStatus of driver curtain airbag.SmartDeviceLink 1.0
passengerAirbagDeployedVehicleDataEventStatusStatus of passenger airbag.SmartDeviceLink 1.0
passengerCurtainAirbagDeployedVehicleDataEventStatusStatus of passenger curtain airbag.SmartDeviceLink 1.0
driverKneeAirbagDeployedVehicleDataEventStatusStatus of driver knee airbag.SmartDeviceLink 1.0
passengerSideAirbagDeployedVehicleDataEventStatusStatus of passenger side airbag.SmartDeviceLink 1.0
passengerKneeAirbagDeployedVehicleDataEventStatusStatus of passenger knee airbagSmartDeviceLink 1.0
NameTypeDescriptionSmartDeviceLink Version.
driverAirbagDeployed VehicleDataEventStatusStatus of driver airbag.SmartDeviceLink 1.0
driverSideAirbagDeployedVehicleDataEventStatusStatus of driver side airbag.SmartDeviceLink 1.0
driverCurtainAirbagDeployedVehicleDataEventStatusStatus of driver curtain airbag.SmartDeviceLink 1.0
passengerAirbagDeployedVehicleDataEventStatusStatus of passenger airbag.SmartDeviceLink 1.0
passengerCurtainAirbagDeployedVehicleDataEventStatusStatus of passenger curtain airbag.SmartDeviceLink 1.0
driverKneeAirbagDeployedVehicleDataEventStatusStatus of driver knee airbag.SmartDeviceLink 1.0
passengerSideAirbagDeployedVehicleDataEventStatusStatus of passenger side airbag.SmartDeviceLink 1.0
passengerKneeAirbagDeployedVehicleDataEventStatusStatus of passenger knee airbagSmartDeviceLink 1.0
* @@ -106,7 +106,7 @@ import java.util.Hashtable; * If a resultCode of "SUCCESS" is returned, the request was accepted by SDL. By the time the corresponding response is received, the Alert will have completed. * *

Non-default Result Codes:

- *

REJECTED

ABORTED

+ *

REJECTED

ABORTED

* * @see Image * @see SubscribeVehicleData diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/Alert.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/Alert.java index 2dda0037c..133ee678a 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/Alert.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/Alert.java @@ -66,94 +66,94 @@ import java.util.List; * If the app has been granted function group Notification the HMILevel can * also be BACKGROUND * - * - * - * - * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * + * + * + * *
NameTypeDescription
NameTypeDescriptionReq.NotesVersion Available
alertText1StringText to be displayed in the first field of the display during the Alert. NotesVersion Available
alertText1StringText to be displayed in the first field of the display during the Alert. NLength is limited to what is indicated in RegisterAppInterface response. If omitted, top display line will be cleared. Text is always centeredSmartDeviceLink 1.0
alertText2StringText to be displayed in the second field of the display during the Alert. Length is limited to what is indicated in RegisterAppInterface response. If omitted, top display line will be cleared. Text is always centeredSmartDeviceLink 1.0
alertText2StringText to be displayed in the second field of the display during the Alert. NOnly permitted if HMI supports a second display line. Length is limited to what is indicated in RegisterAppInterface response. If omitted, second display line will be cleared. SmartDeviceLink 1.0
alertText3StringText to be displayed in the third field of the display during the Alert.Only permitted if HMI supports a second display line. Length is limited to what is indicated in RegisterAppInterface response. If omitted, second display line will be cleared. SmartDeviceLink 1.0
alertText3StringText to be displayed in the third field of the display during the Alert.NArray must have a least one element. SmartDeviceLink 1.0
ttsChunksTTSChunk[]Array of type TTSChunk which, taken together, specify what is to be spoken to the user.Array must have a least one element. SmartDeviceLink 1.0
ttsChunksTTSChunk[]Array of type TTSChunk which, taken together, specify what is to be spoken to the user.NArray must have a least one element. SmartDeviceLink 1.0
durationIntegerThe duration of the displayed portion of the alert, in milliseconds. After this amount of time has passed, the display fields alertText1 and alertText2 will revert to what was displayed in those fields before the alert began.Array must have a least one element. SmartDeviceLink 1.0
durationIntegerThe duration of the displayed portion of the alert, in milliseconds. After this amount of time has passed, the display fields alertText1 and alertText2 will revert to what was displayed in those fields before the alert began.NMin Value: 3000 Max Value: 10000. If omitted, the default is 5000 millisecondsSmartDeviceLink 1.0
playToneBooleanSpecifies whether the alert tone should be played before the TTS (if any) is spoken.Min Value: 3000 Max Value: 10000. If omitted, the default is 5000 millisecondsSmartDeviceLink 1.0
playToneBooleanSpecifies whether the alert tone should be played before the TTS (if any) is spoken.NIf omitted, default is true.SmartDeviceLink 1.0
softButtonsSoftButton[]Specifies the soft buttons, the apps wants to use in this alert.If omitted, default is true.SmartDeviceLink 1.0
softButtonsSoftButton[]Specifies the soft buttons, the apps wants to use in this alert.NIf omitted on supported displays, the alert will not have any SoftButton.ArrayMin: 0; ArrayMax: 4SmartDeviceLink 1.0
progressIndicatorBooleanIf supported on the given platform, the alert GUI will include some sort of animation indicating that loading of a feature is progressing. e.g. a spinning wheel or hourglass, etc.NSmartDeviceLink 1.0
cancelIDIntegerAn ID for this specific alert to allow cancellation through the `CancelInteraction` RPC.If omitted on supported displays, the alert will not have any SoftButton.ArrayMin: 0; ArrayMax: 4SmartDeviceLink 1.0
progressIndicatorBooleanIf supported on the given platform, the alert GUI will include some sort of animation indicating that loading of a feature is progressing. e.g. a spinning wheel or hourglass, etc.NSmartDeviceLink 1.0
cancelIDIntegerAn ID for this specific alert to allow cancellation through the `CancelInteraction` RPC.NSmartDeviceLink 6.0
alertIconImageImage struct determining whether the icon is static or dynamic. If omitted on supported displays, no (or the default if applicable) icon should be displayed.SmartDeviceLink 6.0
alertIconImageImage struct determining whether the icon is static or dynamic. If omitted on supported displays, no (or the default if applicable) icon should be displayed.NSmartDeviceLink 6.0.0
SmartDeviceLink 6.0.0
* * @see GetVehicleData diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/AudioPassThruCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/AudioPassThruCapabilities.java index 701057d35..00d36f95a 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/AudioPassThruCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/AudioPassThruCapabilities.java @@ -46,33 +46,33 @@ import java.util.Hashtable; * *

Parameter List

* - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * *
NameTypeDescriptionSmartDeviceLink Ver. Available
samplingRateSamplingRateDescribes the sampling rate for AudioPassThru - * SmartDeviceLink 2.0
bitsPerSampleBitsPerSampleDescribes the sample depth in bit for AudioPassThru - * SmartDeviceLink 2.0
audioTypeAudioTypeDescribes the audioType for AudioPassThru - * SmartDeviceLink 2.0
NameTypeDescriptionSmartDeviceLink Ver. Available
samplingRateSamplingRateDescribes the sampling rate for AudioPassThru + * SmartDeviceLink 2.0
bitsPerSampleBitsPerSampleDescribes the sample depth in bit for AudioPassThru + * SmartDeviceLink 2.0
audioTypeAudioTypeDescribes the audioType for AudioPassThru + * SmartDeviceLink 2.0
* * @since SmartDeviceLink 2.0 diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/BeltStatus.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/BeltStatus.java index 9c8060ea4..5387645de 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/BeltStatus.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/BeltStatus.java @@ -44,102 +44,102 @@ import java.util.Hashtable; *

Parameter List

* * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * *
Param NameTypeMandatoryDescription
driverBeltDeployedVehicleDataEventStatusfalseThe driver seat belt is deployed.
passengerBeltDeployedVehicleDataEventStatusfalseThe passenger seat belt is deployed.
passengerBuckleBeltedVehicleDataEventStatusfalseThe passenger seat belt is buckled.
driverBuckleBeltedVehicleDataEventStatusfalseThe driver seat belt is buckled.
leftRow2BuckleBeltedVehicleDataEventStatusfalseThe left seat belt of the 2nd row is buckled.
passengerChildDetectedVehicleDataEventStatusfalseThe child passenger is detected.
rightRow2BuckleBeltedVehicleDataEventStatusfalseThe right seat belt of the 2nd row is buckled.
middleRow2BuckleBeltedVehicleDataEventStatusfalseThe middle seat belt of the 2nd row is buckled.
middleRow3BuckleBeltedVehicleDataEventStatusfalseThe middle seat belt of the 3rd row is buckled.
leftRow3BuckleBeltedVehicleDataEventStatusfalseThe left seat belt of the 3rd row is buckled.
rightRow3BuckleBeltedVehicleDataEventStatusfalseThe right seat belt of the 3rd row is buckled.
leftRearInflatableBeltedVehicleDataEventStatusfalseThe left rear inflatable is belted.
rightRearInflatableBeltedVehicleDataEventStatusfalseThe right rear inflatable is belted.
middleRow1BeltDeployedVehicleDataEventStatusfalseThe seat belt of the middle row is deployed.
middleRow1BuckleBeltedVehicleDataEventStatusfalseThe seat belt of the middle row is buckled.
Param NameTypeMandatoryDescription
driverBeltDeployedVehicleDataEventStatusfalseThe driver seat belt is deployed.
passengerBeltDeployedVehicleDataEventStatusfalseThe passenger seat belt is deployed.
passengerBuckleBeltedVehicleDataEventStatusfalseThe passenger seat belt is buckled.
driverBuckleBeltedVehicleDataEventStatusfalseThe driver seat belt is buckled.
leftRow2BuckleBeltedVehicleDataEventStatusfalseThe left seat belt of the 2nd row is buckled.
passengerChildDetectedVehicleDataEventStatusfalseThe child passenger is detected.
rightRow2BuckleBeltedVehicleDataEventStatusfalseThe right seat belt of the 2nd row is buckled.
middleRow2BuckleBeltedVehicleDataEventStatusfalseThe middle seat belt of the 2nd row is buckled.
middleRow3BuckleBeltedVehicleDataEventStatusfalseThe middle seat belt of the 3rd row is buckled.
leftRow3BuckleBeltedVehicleDataEventStatusfalseThe left seat belt of the 3rd row is buckled.
rightRow3BuckleBeltedVehicleDataEventStatusfalseThe right seat belt of the 3rd row is buckled.
leftRearInflatableBeltedVehicleDataEventStatusfalseThe left rear inflatable is belted.
rightRearInflatableBeltedVehicleDataEventStatusfalseThe right rear inflatable is belted.
middleRow1BeltDeployedVehicleDataEventStatusfalseThe seat belt of the middle row is deployed.
middleRow1BuckleBeltedVehicleDataEventStatusfalseThe seat belt of the middle row is buckled.
* * @see VehicleDataEventStatus diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/BodyInformation.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/BodyInformation.java index 62a006abe..90b7e0374 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/BodyInformation.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/BodyInformation.java @@ -47,111 +47,111 @@ import java.util.List; * *

Parameter List

* - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * *
Param NameTypeMandatoryDescriptionVersion
parkBrakeActiveBooleantrueDescribes, if the park break is active. The information about the park brake: - true, if active - false if not.SmartDeviceLink 2.0
ignitionStableStatusIgnitionStableStatustrueDescribes, if the ignition situation is considered stableThe information about stability of the ignition switch. See {@linkplain IgnitionStableStatus}SmartDeviceLink 2.0
ignitionStatusIgnitionStatustrueThe information about ignition status. See {@linkplain IgnitionStatus}SmartDeviceLink 2.0
parkBrakeActiveBooleantrueThe information about the park brake: - true, if active - false if not.SmartDeviceLink 2.0
driverDoorAjarBooleantrueThe information about the park brake: - true, if active - false if not. - * @since SmartDeviceLink 2.0.0 - * @property-deprecated in SmartDeviceLink 7.1.0 - *
passengerDoorAjarBooleantrueThe information about the park brake: - true, if active - false if not. - * @since SmartDeviceLink 2.0.0 - * @property-deprecated in SmartDeviceLink 7.1.0 - *
rearLeftDoorAjarBooleantrueThe information about the park brake: - true, if active - false if not. - * @since SmartDeviceLink 2.0.0 - * @property-deprecated in SmartDeviceLink 7.1.0 - *
rearRightDoorAjarBooleantrueReferences signal "DrStatRr_B_Actl". - * @since SmartDeviceLink 2.0.0 - * @property-deprecated in SmartDeviceLink 7.1.0 - *
doorStatusesListProvides status for doors if Ajar/Closed/LockedN{"array_min_size": 0, "array_max_size": 100} - * @since SmartDeviceLink 7.1.0 - *
gateStatusesListProvides status for trunk/hood/etc. if Ajar/Closed/LockedN{"array_min_size": 0, "array_max_size": 100} - * @since SmartDeviceLink 7.1.0 - *
roofStatusesListProvides status for roof/convertible roof/sunroof/moonroof etc., if Closed/Ajar/Removedetc.N{"array_min_size": 0, "array_max_size": 100} - * @since SmartDeviceLink 7.1.0 - *
Param NameTypeMandatoryDescriptionVersion
parkBrakeActiveBooleantrueDescribes, if the park break is active. The information about the park brake: - true, if active - false if not.SmartDeviceLink 2.0
ignitionStableStatusIgnitionStableStatustrueDescribes, if the ignition situation is considered stableThe information about stability of the ignition switch. See {@linkplain IgnitionStableStatus}SmartDeviceLink 2.0
ignitionStatusIgnitionStatustrueThe information about ignition status. See {@linkplain IgnitionStatus}SmartDeviceLink 2.0
parkBrakeActiveBooleantrueThe information about the park brake: - true, if active - false if not.SmartDeviceLink 2.0
driverDoorAjarBooleantrueThe information about the park brake: - true, if active - false if not. + * @since SmartDeviceLink 2.0.0 + * @property-deprecated in SmartDeviceLink 7.1.0 + *
passengerDoorAjarBooleantrueThe information about the park brake: - true, if active - false if not. + * @since SmartDeviceLink 2.0.0 + * @property-deprecated in SmartDeviceLink 7.1.0 + *
rearLeftDoorAjarBooleantrueThe information about the park brake: - true, if active - false if not. + * @since SmartDeviceLink 2.0.0 + * @property-deprecated in SmartDeviceLink 7.1.0 + *
rearRightDoorAjarBooleantrueReferences signal "DrStatRr_B_Actl". + * @since SmartDeviceLink 2.0.0 + * @property-deprecated in SmartDeviceLink 7.1.0 + *
doorStatusesListProvides status for doors if Ajar/Closed/LockedN{"array_min_size": 0, "array_max_size": 100} + * @since SmartDeviceLink 7.1.0 + *
gateStatusesListProvides status for trunk/hood/etc. if Ajar/Closed/LockedN{"array_min_size": 0, "array_max_size": 100} + * @since SmartDeviceLink 7.1.0 + *
roofStatusesListProvides status for roof/convertible roof/sunroof/moonroof etc., if Closed/Ajar/Removedetc.N{"array_min_size": 0, "array_max_size": 100} + * @since SmartDeviceLink 7.1.0 + *
* * @see SubscribeVehicleData diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ButtonCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ButtonCapabilities.java index 8895528af..77cedf2e3 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ButtonCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ButtonCapabilities.java @@ -42,43 +42,43 @@ import java.util.Hashtable; * Provides information about the capabilities of a SDL HMI button. *

Parameter List

* - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * * - * - * - * - * - * + * + * + * + * + * * - * - * - * + * + * - * - * + * + * *
NameTypeDescriptionSmartDeviceLink Ver. Available
nameButtonNameThe name of theSDL HMI button.SmartDeviceLink 1.0
shortPressAvailableBooleanThe button supports a SHORT press. See {@linkplain com.smartdevicelink.proxy.rpc.enums.ButtonPressMode} for more information.SmartDeviceLink 1.0
NameTypeDescriptionSmartDeviceLink Ver. Available
nameButtonNameThe name of theSDL HMI button.SmartDeviceLink 1.0
shortPressAvailableBooleanThe button supports a SHORT press. See {@linkplain com.smartdevicelink.proxy.rpc.enums.ButtonPressMode} for more information.SmartDeviceLink 1.0
longPressAvailableBooleanThe button supports a LONG press. See {@linkplain com.smartdevicelink.proxy.rpc.enums.ButtonPressMode} for more information.SmartDeviceLink 1.0
longPressAvailableBooleanThe button supports a LONG press. See {@linkplain com.smartdevicelink.proxy.rpc.enums.ButtonPressMode} for more information.SmartDeviceLink 1.0
upDownAvailableBooleanThe button supports "button down" and "button up". When the button is depressed, the {@linkplain OnButtonEvent} notification will be invoked with a value of BUTTONDOWN. + * upDownAvailableBooleanThe button supports "button down" and "button up". When the button is depressed, the {@linkplain OnButtonEvent} notification will be invoked with a value of BUTTONDOWN. *

When the button is released, the {@linkplain OnButtonEvent} notification will be invoked with a value of BUTTONUP.

SmartDeviceLink 1.0
SmartDeviceLink 1.0
* *

Upon the request HMI must provide the list of the following information:

- *

The names of all existing/supported hardware buttons.

- *

The availability of LONG/SHORT press for each existing/supported hardware button correspondingly

- *

The availability of UP/DOWN events for each existing/supported hardware button correspondingly.

+ *

The names of all existing/supported hardware buttons.

+ *

The availability of LONG/SHORT press for each existing/supported hardware button correspondingly

+ *

The availability of UP/DOWN events for each existing/supported hardware button correspondingly.

* * @see ButtonName * @see com.smartdevicelink.proxy.rpc.enums.ButtonEventMode diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ChangeRegistration.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ChangeRegistration.java index bccb69908..b7f06c160 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ChangeRegistration.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ChangeRegistration.java @@ -56,75 +56,75 @@ import java.util.List; *

Parameter List

* * - * - * - * - * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * + * + * + * * * - * - * - * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * + * + * * - * - * - * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * + * + * *
NameTypeDescription
NameTypeDescription Req.NotesVersion Available
LanguageLanguageRequested SDL voice engine (VR+TTS) language registration.NotesVersion Available
LanguageLanguageRequested SDL voice engine (VR+TTS) language registration.YSmartDeviceLink 2.0
hmiDisplayLanguageLanguageRequest display language registration.SmartDeviceLink 2.0
hmiDisplayLanguageLanguageRequest display language registration.YMinvalue=0; Maxvalue=2000000000SmartDeviceLink 2.0
Minvalue=0; Maxvalue=2000000000SmartDeviceLink 2.0
appNameStringRequest new app name registrationappNameStringRequest new app name registrationNmaxlength:100SmartDeviceLink 2.0
ttsNameTTSChunkRequest new ttsName registrationSmartDeviceLink 2.0
ttsNameTTSChunkRequest new ttsName registrationNminsize:1; maxsize:100SmartDeviceLink 2.0
SmartDeviceLink 2.0
ngnMediaScreenAppNameStringRequest new app short name registrationngnMediaScreenAppNameStringRequest new app short name registrationNmaxlength: 100SmartDeviceLink 2.0
vrSynonymsStringRequest new VR synonyms registrationSmartDeviceLink 2.0
vrSynonymsStringRequest new VR synonyms registrationNmaxlength: 40; minsize:1; maxsize:100SmartDeviceLink 2.0
SmartDeviceLink 2.0
* *

Response

* *

Non-default Result Codes:

- *

SUCCESS

- *

INVALID_DATA

- *

OUT_OF_MEMORY

- *

TOO_MANY_PENDING_REQUESTS

- *

APPLICATION_NOT_REGISTERED

- *

GENERIC_ERROR

- *

REJECTED

+ *

SUCCESS

+ *

INVALID_DATA

+ *

OUT_OF_MEMORY

+ *

TOO_MANY_PENDING_REQUESTS

+ *

APPLICATION_NOT_REGISTERED

+ *

GENERIC_ERROR

+ *

REJECTED

*

DISALLOWED

* * @see RegisterAppInterface diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/Choice.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/Choice.java index 30e00e663..2588719bc 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/Choice.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/Choice.java @@ -45,42 +45,42 @@ import java.util.List; * For example, the application may request for the user`s choice among several suggested ones: Yes, No, Skip. *

Parameter List

* - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * - * - * - * - * - * - * - * - * + * Max: 65535 + * + * + * + * + * + * + * + * + * * - * - * - * - * - * + * + * + * + * + * * - * - * - * - * - * + * + * + * + * + * *
NameTypeDescriptionSmartDeviceLink Ver. Available
choiceIDIntegerApplication-scoped identifier that uniquely identifies this choice. + *
NameTypeDescriptionSmartDeviceLink Ver. Available
choiceIDIntegerApplication-scoped identifier that uniquely identifies this choice. * Min: 0; - * Max: 65535 - * SmartDeviceLink 1.0
menuNameStringText which appears in menu, representing this choice. - * Min: 1; - * Max: 100 - * SmartDeviceLink 1.0
SmartDeviceLink 1.0
menuNameStringText which appears in menu, representing this choice. + * Min: 1; + * Max: 100 + * SmartDeviceLink 1.0
vrCommandsString[]An array of strings to be used as VR synonyms for this choice. If this array is provided, it must have at least one non-empty elementSmartDeviceLink 1.0
vrCommandsString[]An array of strings to be used as VR synonyms for this choice. If this array is provided, it must have at least one non-empty elementSmartDeviceLink 1.0
imageImageEither a static hex icon value or a binary image file name identifier (sent by PutFile).SmartDeviceLink 2.0
imageImageEither a static hex icon value or a binary image file name identifier (sent by PutFile).SmartDeviceLink 2.0
* * @see AddCommand diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ClusterModeStatus.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ClusterModeStatus.java index 883c84153..75a123a94 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ClusterModeStatus.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ClusterModeStatus.java @@ -46,36 +46,36 @@ import java.util.Hashtable; * *

Parameter List

* - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * * - * - * - * - * - * - * + * + * + * + * + * + * * *
Param NameTypeMandatoryDescription
powerModeActiveBooleanReferences signal "PowerMode_UB".
powerModeQualificationStatusPowerModeQualificationStatusReferences signal "PowerModeQF".
carModeStatusCarModeStatusDescribes the car mode the vehicle is in.
Param NameTypeMandatoryDescription
powerModeActiveBooleanReferences signal "PowerMode_UB".
powerModeQualificationStatusPowerModeQualificationStatusReferences signal "PowerModeQF".
carModeStatusCarModeStatusDescribes the car mode the vehicle is in.
powerModeStatusPowerModeStatustrueDescribes the different power modes
powerModeStatusPowerModeStatustrueDescribes the different power modes
* diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/CreateInteractionChoiceSet.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/CreateInteractionChoiceSet.java index 59790154d..1f60f3080 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/CreateInteractionChoiceSet.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/CreateInteractionChoiceSet.java @@ -53,30 +53,30 @@ import java.util.List; * *

Parameter List

* - * - * - * - * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * + * + * *
NameTypeDescription
NameTypeDescriptionReg.NotesVersion
interactionChoiceSetIDIntegerA unique ID that identifies the Choice SetVersion
interactionChoiceSetIDIntegerA unique ID that identifies the Choice SetYMin Value: 0; Max Value: 2000000000SmartDeviceLink 1.0
choiceSetChoice[]Array of one or more elements.SmartDeviceLink 1.0
choiceSetChoice[]Array of one or more elements.YMin Value: 1; Max Value: 100SmartDeviceLink 1.0
SmartDeviceLink 1.0
* * @@ -89,13 +89,13 @@ import java.util.List; * Indicates that the corresponding request either failed or succeeded. If the response returns with a SUCCESS result code, this means the Choice Set was created. * *

Non-default Result Codes:

- *

SUCCESS

- *

INVALID_DATA

- *

OUT_OF_MEMORY

- *

TOO_MANY_PENDING_REQUESTS

- *

APPLICATION_NOT_REGISTERED

- *

GENERIC_ERROR

- *

REJECTED

+ *

SUCCESS

+ *

INVALID_DATA

+ *

OUT_OF_MEMORY

+ *

TOO_MANY_PENDING_REQUESTS

+ *

APPLICATION_NOT_REGISTERED

+ *

GENERIC_ERROR

+ *

REJECTED

*

INVALID_ID

*

DUPLICATE_NAME

*

UNSUPPORTED_RESOURCE

diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DIDResult.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DIDResult.java index a9d14e0b3..271bd30be 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DIDResult.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DIDResult.java @@ -43,35 +43,35 @@ import java.util.Hashtable; * *

Parameter List

* - * - * - * - * + * + * + * + * * - * - * - * - * - * - * + * + * + * + * + * + * * - * - * - * - * - * - * + * + * + * + * + * + * * - * - * + * + * * - * - * - * - * + * + * + * + * * - * - * + * + * *
Param NameTypeMandatory
Param NameTypeMandatory AdditionalDescription
resultCodeVehicleDataResultCodetrueDescription
resultCodeVehicleDataResultCodetrueIndividual DID result code
didLocationIntegertrueIndividual DID result code
didLocationIntegertrueminvalue = 0 maxvalue = 65535 The address of DID location from the ReadDID request.
The address of DID location from the ReadDID request.
dataStringfalse
dataStringfalsemaxlength = 5000 The DID data which is the hex byte string of however many bytes are stored at that location
The DID data which is the hex byte string of however many bytes are stored at that location
* * @see VehicleDataResultCode diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DTC.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DTC.java index 8872f0649..3c29542fc 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DTC.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DTC.java @@ -39,22 +39,22 @@ import java.util.Hashtable; * String containing hexadecimal identifier as well as other common names. *

Parameter List

* - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * *
NameTypeDescriptionSmartDeviceLink Ver. Available
statusByteStringHexadecimal byte string - *
    - *
  • Maxlength = 500
    • - *
- * 		SmartDeviceLink 2.0
NameTypeDescriptionSmartDeviceLink Ver. Available
statusByteStringHexadecimal byte string + *
    + *
  • Maxlength = 500
    • + *
+ * 		SmartDeviceLink 2.0
* * @since SmartDeviceLink 2.0 diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteCommand.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteCommand.java index aa28ade48..302ca0f66 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteCommand.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteCommand.java @@ -48,22 +48,22 @@ import java.util.Hashtable; * *

Parameter List

* - * - * - * - * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * + * + * *
NameTypeDescription
NameTypeDescriptionReg.NotesVersion
cmdIDIntegerUnique ID that identifies the Command to be deleted from Command MenuVersion
cmdIDIntegerUnique ID that identifies the Command to be deleted from Command MenuYMin Value: 0;Max Value: 2000000000SmartDeviceLink 1.0
SmartDeviceLink 1.0
* *

Response:

@@ -71,13 +71,13 @@ import java.util.Hashtable; * Indicates that the corresponding request either failed or succeeded. If the response returns with a SUCCESS result code,this means a command was removed from the Command Menu successfully. * *

Non-default Result Codes:

- *

SUCCESS

- *

INVALID_DATA

- *

OUT_OF_MEMORY

- *

TOO_MANY_PENDING_REQUESTS

- *

APPLICATION_NOT_REGISTERED

- *

GENERIC_ERROR

- *

REJECTED

+ *

SUCCESS

+ *

INVALID_DATA

+ *

OUT_OF_MEMORY

+ *

TOO_MANY_PENDING_REQUESTS

+ *

APPLICATION_NOT_REGISTERED

+ *

GENERIC_ERROR

+ *

REJECTED

*

INVALID_ID

*

IN_USER

* diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteFile.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteFile.java index dc5ad1ea9..23b3daa8b 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteFile.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteFile.java @@ -44,34 +44,34 @@ import java.util.Hashtable; * *

Parameter List

* - * - * - * - * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * + * + * *
NameTypeDescription
NameTypeDescriptionReg.NotesSmartDeviceLink 2.0
SDLFileNameString File reference name.SmartDeviceLink 2.0
SDLFileNameString File reference name.Ymaxlength:500SmartDeviceLink 2.0
SmartDeviceLink 2.0
* *

Response

* *

Non-default Result Codes:

- *

SUCCESS

- *

INVALID_DATA

- *

OUT_OF_MEMORY

- *

TOO_MANY_PENDING_REQUESTS

- *

APPLICATION_NOT_REGISTERED

- *

GENERIC_ERROR

- *

REJECTED

+ *

SUCCESS

+ *

INVALID_DATA

+ *

OUT_OF_MEMORY

+ *

TOO_MANY_PENDING_REQUESTS

+ *

APPLICATION_NOT_REGISTERED

+ *

GENERIC_ERROR

+ *

REJECTED

* * @see PutFile * @see ListFiles diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteInteractionChoiceSet.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteInteractionChoiceSet.java index eac6fc6f5..bc218c46c 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteInteractionChoiceSet.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteInteractionChoiceSet.java @@ -55,22 +55,22 @@ import java.util.Hashtable; *

Parameter List

* * - * - * - * - * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * + * + * *
NameTypeDescription
NameTypeDescriptionReg.NotesVersion
interactionChoiceSetIDInteger A unique ID that identifies the Choice Set (specified in a previous call to CreateInteractionChoiceSet)Version
interactionChoiceSetIDInteger A unique ID that identifies the Choice Set (specified in a previous call to CreateInteractionChoiceSet)YMin Value: 0 ; Max Value: 2000000000SmartDeviceLink 1.0
SmartDeviceLink 1.0
* *

Response

@@ -78,13 +78,13 @@ import java.util.Hashtable; * If a resultCode of "SUCCESS" is returned, the requested choice set has been created and can now be referenced by the application using the value of interactionChoiceSetID provided by the application. * *

Non-default Result Codes:

- *

SUCCESS

- *

INVALID_DATA

- *

OUT_OF_MEMORY

- *

TOO_MANY_PENDING_REQUESTS

- *

APPLICATION_NOT_REGISTERED

- *

GENERIC_ERROR

- *

REJECTED

+ *

SUCCESS

+ *

INVALID_DATA

+ *

OUT_OF_MEMORY

+ *

TOO_MANY_PENDING_REQUESTS

+ *

APPLICATION_NOT_REGISTERED

+ *

GENERIC_ERROR

+ *

REJECTED

*

INVALID_ID

* * @see CreateInteractionChoiceSet diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteSubMenu.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteSubMenu.java index 078504bd0..563e8fc4c 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteSubMenu.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeleteSubMenu.java @@ -49,34 +49,34 @@ import java.util.Hashtable; * *

Parameter List

* - * - * - * - * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * + * + * *
NameTypeDescription
NameTypeDescriptionReg.NotesVersion
menuIDIntegerUnique ID that identifies the SubMenu to be deleteVersion
menuIDIntegerUnique ID that identifies the SubMenu to be deleteYMin Value: 0; Max Value: 2000000000SmartDeviceLink 1.0
SmartDeviceLink 1.0
* *

Response

* *

Non-default Result Codes:

*

SUCCESS

- *

INVALID_DATA

- *

OUT_OF_MEMORY

- *

TOO_MANY_PENDING_REQUESTS

- *

APPLICATION_NOT_REGISTERED

- *

GENERIC_ERROR

- *

REJECTED

+ *

INVALID_DATA

+ *

OUT_OF_MEMORY

+ *

TOO_MANY_PENDING_REQUESTS

+ *

APPLICATION_NOT_REGISTERED

+ *

GENERIC_ERROR

+ *

REJECTED

*

INVALID_ID

*

IN_USE

* diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeviceInfo.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeviceInfo.java index 9a98a997b..cce0d4225 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeviceInfo.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeviceInfo.java @@ -43,62 +43,62 @@ import java.util.Hashtable; *

Parameter List

* * - * - * - * - * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * + * + * *
NameTypeDescription
NameTypeDescriptionReg.NotesVersion
hardwareStringDevice modelVersion
hardwareStringDevice modelNMax Length: 500SmartDeviceLink 3.0
firmwareRevStringDevice firmware revisionSmartDeviceLink 3.0
firmwareRevStringDevice firmware revisionNMax Length: 500SmartDeviceLink 3.0
osStringDevice OS versionSmartDeviceLink 3.0
osStringDevice OS versionNMax Length: 500SmartDeviceLink 3.0
osVersionStringDevice OS versionSmartDeviceLink 3.0
osVersionStringDevice OS versionNMax Length: 500SmartDeviceLink 3.0
carrierStringDevice mobile carrier (if applicable)SmartDeviceLink 3.0
carrierStringDevice mobile carrier (if applicable)NMax Length: 500SmartDeviceLink 3.0
maxNumberRFCOMMPortsIntegerOmitted if connected not via BT.SmartDeviceLink 3.0
maxNumberRFCOMMPortsIntegerOmitted if connected not via BT.NMin Value: 0; Max Value: 100SmartDeviceLink 3.0
SmartDeviceLink 3.0
*/ public class DeviceInfo extends RPCStruct { diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeviceStatus.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeviceStatus.java index a857a50e9..bfda4da9e 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DeviceStatus.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DeviceStatus.java @@ -43,89 +43,89 @@ import java.util.Hashtable; * Describes the status related to a connected mobile device or SDL and if or how it is represented in the vehicle. *

Parameter List

* - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * *
NameTypeDescriptionSmartDeviceLink Ver. Available
voiceRecOnBooleanVoice recognition is on - * SmartDeviceLink 2.0
btIconOnBooleanBluetooth connection established - * SmartDeviceLink 2.0
callActiveBooleanA call is being active - * SmartDeviceLink 2.0
phoneRoamingBooleanThe phone is in roaming mode - * SmartDeviceLink 2.0
textMsgAvailableBooleanA text message is available - * SmartDeviceLink 2.0
battLevelStatusDeviceLevelStatusBattery level status - * SmartDeviceLink 2.0
stereoAudioOutputMutedBooleanStatus of the stereo audio output channel - * SmartDeviceLink 2.0
monoAudioOutputMutedBooleanStatus of the mono audio output channel - * SmartDeviceLink 2.0
signalLevelStatusDeviceLevelStatusSignal level status - * SmartDeviceLink 2.0
primaryAudioSourcePrimaryAudioSourceReflects the current primary audio source of SDL (if selected). - * SmartDeviceLink 2.0
eCallEventActiveBooleanReflects, if an eCall event is active - * SmartDeviceLink 2.0
NameTypeDescriptionSmartDeviceLink Ver. Available
voiceRecOnBooleanVoice recognition is on + * SmartDeviceLink 2.0
btIconOnBooleanBluetooth connection established + * SmartDeviceLink 2.0
callActiveBooleanA call is being active + * SmartDeviceLink 2.0
phoneRoamingBooleanThe phone is in roaming mode + * SmartDeviceLink 2.0
textMsgAvailableBooleanA text message is available + * SmartDeviceLink 2.0
battLevelStatusDeviceLevelStatusBattery level status + * SmartDeviceLink 2.0
stereoAudioOutputMutedBooleanStatus of the stereo audio output channel + * SmartDeviceLink 2.0
monoAudioOutputMutedBooleanStatus of the mono audio output channel + * SmartDeviceLink 2.0
signalLevelStatusDeviceLevelStatusSignal level status + * SmartDeviceLink 2.0
primaryAudioSourcePrimaryAudioSourceReflects the current primary audio source of SDL (if selected). + * SmartDeviceLink 2.0
eCallEventActiveBooleanReflects, if an eCall event is active + * SmartDeviceLink 2.0
* * @see DeviceLevelStatus diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DiagnosticMessage.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DiagnosticMessage.java index bceb32de3..dcb79bc24 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DiagnosticMessage.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DiagnosticMessage.java @@ -44,43 +44,43 @@ import java.util.List; * *

Parameter List

* - * - * - * - * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * + * + * *
NameTypeDescription
NameTypeDescriptionReg.NotesVersion
targetIDIntegerName of target ECU.Version
targetIDIntegerName of target ECU.YMin Value: 0; Max Value: 65535SmartDeviceLink 3.0
messageLengthIntegerLength of message (in bytes).SmartDeviceLink 3.0
messageLengthIntegerLength of message (in bytes).YMin Value: 0; Max Value:65535SmartDeviceLink 3.0
messageDataIntegerArray of bytes comprising CAN message.SmartDeviceLink 3.0
messageDataIntegerArray of bytes comprising CAN message.YMin Value: 0; Max Value:255; Min Size:1; Max Size:65535SmartDeviceLink 3.0
SmartDeviceLink 3.0
*

HMI must:

* - *

1. Check the requested data using provided information of targetID (name of ECU),messageLength and messageData.

- *

2. Respond with one of the appropriate result codes.And in case of SUCCESS return messageDataResult which is an array of bytes comprising CAN message result.

+ *

1. Check the requested data using provided information of targetID (name of ECU),messageLength and messageData.

+ *

2. Respond with one of the appropriate result codes.And in case of SUCCESS return messageDataResult which is an array of bytes comprising CAN message result.

* * @since SmartDeviceLink 3.0 */ diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/DisplayCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/DisplayCapabilities.java index 05a49adc0..7ec2c1484 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/DisplayCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/DisplayCapabilities.java @@ -45,46 +45,46 @@ import java.util.List; * Contains information about the display for the SDL system to which the application is currently connected. *

Parameter List

* - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * *
NameTypeDescriptionSmartDeviceLink Ver. Available
@property-deprecated displayTypeDisplayTypeThe type of display - * SmartDeviceLink 1.0
displayNameStringThe name of the display - * SmartDeviceLink 5.0
textFieldTextField[]An array of TextField structures, each of which describes a field in the HMI which the application can write to using operations such as {@linkplain Show}, {@linkplain SetMediaClockTimer}, etc. - * This array of TextField structures identify all the text fields to which the application can write on the current display (identified by DisplayType ). - * SmartDeviceLink 1.0
mediaClockFormatsMediaClockFormat[]An array of MediaClockFormat elements, defining the valid string formats used in specifying the contents of the media clock fieldSmartDeviceLink 1.0
graphicSupportedBooleanThe display's persistent screen supports referencing a static or dynamic image.SmartDeviceLink 2.0
NameTypeDescriptionSmartDeviceLink Ver. Available
@property-deprecated displayTypeDisplayTypeThe type of display + * SmartDeviceLink 1.0
displayNameStringThe name of the display + * SmartDeviceLink 5.0
textFieldTextField[]An array of TextField structures, each of which describes a field in the HMI which the application can write to using operations such as {@linkplain Show}, {@linkplain SetMediaClockTimer}, etc. + * This array of TextField structures identify all the text fields to which the application can write on the current display (identified by DisplayType ). + * SmartDeviceLink 1.0
mediaClockFormatsMediaClockFormat[]An array of MediaClockFormat elements, defining the valid string formats used in specifying the contents of the media clock fieldSmartDeviceLink 1.0
graphicSupportedBooleanThe display's persistent screen supports referencing a static or dynamic image.SmartDeviceLink 2.0
* * @see DisplayType diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ECallInfo.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ECallInfo.java index 1858748d6..a49794e69 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ECallInfo.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ECallInfo.java @@ -44,38 +44,38 @@ import java.util.Hashtable; * *

Parameter List

* - * - * - * - * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * + * + * + * *
Param NameTypeDescription
Param NameTypeDescription Req.NotesVersion Available
eCallNotificationStatusVehicleDataNotificationStatusReferences signal "eCallNotification_4A".NotesVersion Available
eCallNotificationStatusVehicleDataNotificationStatusReferences signal "eCallNotification_4A".SmartDeviceLink 2.0
auxECallNotificationStatusVehicleDataNotificationStatusReferences signal "eCallNotification". This is an alternative signal available on some car lines replacing the eCallNotificationStatus, but showing the same values.SmartDeviceLink 2.0
auxECallNotificationStatusVehicleDataNotificationStatusReferences signal "eCallNotification". This is an alternative signal available on some car lines replacing the eCallNotificationStatus, but showing the same values.SmartDeviceLink 2.0
eCallConfirmationStatusECallConfirmationStatusReferences signal "eCallConfirmation"SmartDeviceLink 2.0
eCallConfirmationStatusECallConfirmationStatusReferences signal "eCallConfirmation"SmartDeviceLink 2.0
SmartDeviceLink 2.0
* * @see SubscribeVehicleData diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/EmergencyEvent.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/EmergencyEvent.java index 621cca031..aaf829ba3 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/EmergencyEvent.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/EmergencyEvent.java @@ -45,56 +45,56 @@ import java.util.Hashtable; * *

Parameter List

* - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * * * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * *
Param NameTypeMandatoryDescriptionNotesVersion Available
emergencyEventTypeEmergencyEventTypeReferences signal "VedsEvntType_D_Ltchd". See{@linkplain EmergencyEventType}SmartDeviceLink 2.0
fuelCutoffStatusFuelCutoffStatusReferences signal "RCM_FuelCutoff". See{@linkplain FuelCutoffStatus}SmartDeviceLink 2.0
rolloverEventVehicleDataEventStatusReferences signal "VedsEvntRoll_D_Ltchd". See{@linkplain VehicleDataEventStatus}SmartDeviceLink 2.0
maximumChangeVelocityIntegerReferences signal "VedsMaxDeltaV_D_Ltchd".minvalue=0; maxvalue=255;

Additional reserved values:

0x00 No event; 0xFE Not supported; 0xFF Fault

SmartDeviceLink 2.0
Param NameTypeMandatoryDescriptionNotesVersion Available
emergencyEventTypeEmergencyEventTypeReferences signal "VedsEvntType_D_Ltchd". See{@linkplain EmergencyEventType}SmartDeviceLink 2.0
fuelCutoffStatusFuelCutoffStatusReferences signal "RCM_FuelCutoff". See{@linkplain FuelCutoffStatus}SmartDeviceLink 2.0
rolloverEventVehicleDataEventStatusReferences signal "VedsEvntRoll_D_Ltchd". See{@linkplain VehicleDataEventStatus}SmartDeviceLink 2.0
maximumChangeVelocityIntegerReferences signal "VedsMaxDeltaV_D_Ltchd".minvalue=0; maxvalue=255;

Additional reserved values:

0x00 No event; 0xFE Not supported; 0xFF Fault

SmartDeviceLink 2.0
multipleEventsVehicleDataEventStatusReferences signal "VedsMultiEvnt_D_Ltchd". See{@linkplain VehicleDataEventStatus}SmartDeviceLink 2.0
multipleEventsVehicleDataEventStatusReferences signal "VedsMultiEvnt_D_Ltchd". See{@linkplain VehicleDataEventStatus}SmartDeviceLink 2.0
* * @see Image diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GPSData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GPSData.java index d199be5e2..79bfdd187 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GPSData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GPSData.java @@ -44,135 +44,135 @@ import java.util.Hashtable; * Describes the GPS data. Not all data will be available on all car lines. *

Parameter List

* - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * *
NameTypeDescriptionSmartDeviceLink Ver. Available
longitudeDegreesDoubleMinvalue: - 180 - * Maxvalue: 180 - * SmartDeviceLink 2.0
latitudeDegreesDoubleMinvalue: - 90Maxvalue: 90 - * SmartDeviceLink 2.0
utcYearIntegerMinvalue: 2010Maxvalue: 2100 - * SmartDeviceLink 2.0
utcMonthIntegerMinvalue: 1Maxvalue: 12 - * SmartDeviceLink 2.0
utcDayIntegerMinvalue: 1Maxvalue: 31 - * SmartDeviceLink 2.0
utcHoursIntegerMinvalue: 0Maxvalue: 23 - * SmartDeviceLink 2.0
utcMinutesIntegerMinvalue: 0Maxvalue: 59 - * SmartDeviceLink 2.0
utcSecondsIntegerMinvalue: 0Maxvalue: 59 - * SmartDeviceLink 2.0
pdopIntegerPositional Dilution of Precision. If undefined or unavailable, then value shall be set to 0.Minvalue: 0Maxvalue: 1000 - * SmartDeviceLink 2.0
hdopIntegerHorizontal Dilution of Precision. If value is unknown, value shall be set to 0.Minvalue: 0Maxvalue: 1000 - * SmartDeviceLink 2.0
vdopIntegerVertical Dilution of Precision. If value is unknown, value shall be set to 0.Minvalue: 0Maxvalue: 1000 - * SmartDeviceLink 2.0
actualBooleanTrue, if coordinates are based on satellites. - * False, if based on dead reckoning - * SmartDeviceLink 2.0
satellitesIntegerNumber of satellites in view - * Minvalue: 0 - * Maxvalue: 31 - * SmartDeviceLink 2.0
altitudeIntegerAltitude in meters - * Minvalue: -10000 - * Maxvalue: 10000 - * Note: SYNC uses Mean Sea Level for calculating GPS. SmartDeviceLink 2.0
headingDoubleThe heading. North is 0, East is 90, etc. - * Minvalue: 0 - * Maxvalue: 359.99 - * Resolution is 0.01 - * SmartDeviceLink 2.0
speedIntegerThe speed in KPH - * Minvalue: 0 - * Maxvalue: 500 - * SmartDeviceLink 2.0
NameTypeDescriptionSmartDeviceLink Ver. Available
longitudeDegreesDoubleMinvalue: - 180 + * Maxvalue: 180 + * SmartDeviceLink 2.0
latitudeDegreesDoubleMinvalue: - 90Maxvalue: 90 + * SmartDeviceLink 2.0
utcYearIntegerMinvalue: 2010Maxvalue: 2100 + * SmartDeviceLink 2.0
utcMonthIntegerMinvalue: 1Maxvalue: 12 + * SmartDeviceLink 2.0
utcDayIntegerMinvalue: 1Maxvalue: 31 + * SmartDeviceLink 2.0
utcHoursIntegerMinvalue: 0Maxvalue: 23 + * SmartDeviceLink 2.0
utcMinutesIntegerMinvalue: 0Maxvalue: 59 + * SmartDeviceLink 2.0
utcSecondsIntegerMinvalue: 0Maxvalue: 59 + * SmartDeviceLink 2.0
pdopIntegerPositional Dilution of Precision. If undefined or unavailable, then value shall be set to 0.Minvalue: 0Maxvalue: 1000 + * SmartDeviceLink 2.0
hdopIntegerHorizontal Dilution of Precision. If value is unknown, value shall be set to 0.Minvalue: 0Maxvalue: 1000 + * SmartDeviceLink 2.0
vdopIntegerVertical Dilution of Precision. If value is unknown, value shall be set to 0.Minvalue: 0Maxvalue: 1000 + * SmartDeviceLink 2.0
actualBooleanTrue, if coordinates are based on satellites. + * False, if based on dead reckoning + * SmartDeviceLink 2.0
satellitesIntegerNumber of satellites in view + * Minvalue: 0 + * Maxvalue: 31 + * SmartDeviceLink 2.0
altitudeIntegerAltitude in meters + * Minvalue: -10000 + * Maxvalue: 10000 + * Note: SYNC uses Mean Sea Level for calculating GPS. SmartDeviceLink 2.0
headingDoubleThe heading. North is 0, East is 90, etc. + * Minvalue: 0 + * Maxvalue: 359.99 + * Resolution is 0.01 + * SmartDeviceLink 2.0
speedIntegerThe speed in KPH + * Minvalue: 0 + * Maxvalue: 500 + * SmartDeviceLink 2.0
* * @since SmartDeviceLink 2.0 diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GenericResponse.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GenericResponse.java index 0c3c70ee6..d4c0f36d8 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GenericResponse.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GenericResponse.java @@ -45,38 +45,38 @@ import java.util.Hashtable; * INVALID_DATA is used. *

Parameter List

* - * - * - * - * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * + * + * + * *
Param NameTypeDescription
Param NameTypeDescription Req.NotesVersion Available
successBooleantrue, if successful; false, if failedNotesVersion Available
successBooleantrue, if successful; false, if failedSmartDeviceLink 1.0
resultCodeResultDefines the possible result codes returned by SDL to the application in a Response to a requested operationSmartDeviceLink 1.0
resultCodeResultDefines the possible result codes returned by SDL to the application in a Response to a requested operationSmartDeviceLink 1.0
infoStringProvides additional human readable info regarding the result.SmartDeviceLink 1.0
infoStringProvides additional human readable info regarding the result.Nmaxlength=1000SmartDeviceLink 1.0
maxlength=1000SmartDeviceLink 1.0
* @since SmartDeviceLink 1.0 */ diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetDTCs.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetDTCs.java index dc8b4828f..0d7cc14b9 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetDTCs.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetDTCs.java @@ -48,30 +48,30 @@ import java.util.Hashtable; * *

Parameter List

* - * - * - * - * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * + * + * *
NameTypeDescription
NameTypeDescriptionReg.NotesVersion
ecuNameIntegerName of ECU.Version
ecuNameIntegerName of ECU.YMin Value: 0; Max Value: 65535SmartDeviceLink 2.0
dtcMaskIntegerDTC Mask Byte to be sent in diagnostic request to module.SmartDeviceLink 2.0
dtcMaskIntegerDTC Mask Byte to be sent in diagnostic request to module.NMin Value: 0; Max Value: 255SmartDeviceLink 2.0
SmartDeviceLink 2.0
*

Response

* diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetVehicleData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetVehicleData.java index b723f08b9..005196f9b 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/GetVehicleData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/GetVehicleData.java @@ -41,90 +41,90 @@ import java.util.Hashtable; * *

Parameter List

* - * - * - * - * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * + * + * + * * * * @@ -139,117 +139,117 @@ import java.util.Hashtable; * * * - * - * - * - * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * * * * @@ -257,7 +257,7 @@ import java.util.Hashtable; * * * - * + * * * * @@ -292,7 +292,7 @@ import java.util.Hashtable; * @since SmartDeviceLink 7.1.0 * * - *
NameTypeDescription
NameTypeDescriptionReg.NotesVersion
gpsBooleanGPS data. See {@linkplain com.smartdevicelink.proxy.rpc.GPSData }for detailsVersion
gpsBooleanGPS data. See {@linkplain com.smartdevicelink.proxy.rpc.GPSData }for detailsNSubscribableSmartDeviceLink 2.0
speedBooleanThe vehicle speed in kilometers per hourSmartDeviceLink 2.0
speedBooleanThe vehicle speed in kilometers per hourNSubscribableSmartDeviceLink 2.0
rpmBooleanThe number of revolutions per minute of the engineSmartDeviceLink 2.0
rpmBooleanThe number of revolutions per minute of the engineNSubscribableSmartDeviceLink 2.0
fuelLevelBooleanThe fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec7.0, please see fuelRange.SmartDeviceLink 2.0
fuelLevelBooleanThe fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec7.0, please see fuelRange.NSubscribableSmartDeviceLink 7.0.0
fuelLevel_StateBooleanThe fuel level state. This parameter is deprecated starting RPC Spec 7.0, please see fuelRange.SmartDeviceLink 7.0.0
fuelLevel_StateBooleanThe fuel level state. This parameter is deprecated starting RPC Spec 7.0, please see fuelRange.NSubscribableSmartDeviceLink 7.0.0
fuelRangeBooleanThe fuel type, estimated range in KM, fuel level/capacity and fuel level state for the vehicle. See struct FuelRange for details.SmartDeviceLink 7.0.0
fuelRangeBooleanThe fuel type, estimated range in KM, fuel level/capacity and fuel level state for the vehicle. See struct FuelRange for details.NSubscribableSmartDeviceLink 5.0.0
instantFuelConsumptionBooleanThe instantaneous fuel consumption in micro litresSmartDeviceLink 5.0.0
instantFuelConsumptionBooleanThe instantaneous fuel consumption in micro litresNSubscribableSmartDeviceLink 2.0
externalTemperatureBooleanThe external temperature in degrees celsius. This parameter is deprecated starting RPCSpec 7.1.0, please see climateData.SmartDeviceLink 2.0
externalTemperatureBooleanThe external temperature in degrees celsius. This parameter is deprecated starting RPCSpec 7.1.0, please see climateData.NSubscribable - * @since SmartDeviceLink 2.0.0 - * @property-deprecated in SmartDeviceLink 7.1.0 - *
vinBooleanVehicle identification number + * @since SmartDeviceLink 2.0.0 + * @property-deprecated in SmartDeviceLink 7.1.0 + *
vinBooleanVehicle identification numberNSubscribableSmartDeviceLink 2.0
SmartDeviceLink 2.0
gearStatusBooleanNSmartDeviceLink 7.0.0
tirePressureBooleanTire pressure status
tirePressureBooleanTire pressure statusNSubscribableSmartDeviceLink 2.0
odometerBooleanOdometer in kmSmartDeviceLink 2.0
odometerBooleanOdometer in kmNMax Length: 500SmartDeviceLink 2.0
beltStatusBooleanThe status of the seat beltsSmartDeviceLink 2.0
beltStatusBooleanThe status of the seat beltsNSubscribableSmartDeviceLink 2.0
bodyInformationBooleanThe body information including ignition status and internal tempSmartDeviceLink 2.0
bodyInformationBooleanThe body information including ignition status and internal tempNSubscribableSmartDeviceLink 2.0
deviceStatusBooleanThe device status including signal and battery strengthSmartDeviceLink 2.0
deviceStatusBooleanThe device status including signal and battery strengthNSubscribableSmartDeviceLink 2.0
driverBrakingBooleanThe status of the brake pedalSmartDeviceLink 2.0
driverBrakingBooleanThe status of the brake pedalNSubscribableSmartDeviceLink 2.0
wiperStatusBooleanThe status of the wipersSmartDeviceLink 2.0
wiperStatusBooleanThe status of the wipersNSubscribableSmartDeviceLink 2.0
headLampStatusBooleanStatus of the head lampsSmartDeviceLink 2.0
headLampStatusBooleanStatus of the head lampsNSubscribableSmartDeviceLink 2.0
engineTorqueBooleanTorque value for engine (in Nm) on non-diesel variantsSmartDeviceLink 2.0
engineTorqueBooleanTorque value for engine (in Nm) on non-diesel variantsNSubscribableSmartDeviceLink 2.0
engineOilLifeBooleanThe estimated percentage of remaining oil life of the engineSmartDeviceLink 2.0
engineOilLifeBooleanThe estimated percentage of remaining oil life of the engineNSubscribableSmartDeviceLink 5.0
accPedalPositionBooleanAccelerator pedal position (percentage depressed)SmartDeviceLink 5.0
accPedalPositionBooleanAccelerator pedal position (percentage depressed)NSubscribableSmartDeviceLink 2.0
steeringWheelAngleBooleanCurrent angle of the steering wheel (in deg)SmartDeviceLink 2.0
steeringWheelAngleBooleanCurrent angle of the steering wheel (in deg)NSubscribableSmartDeviceLink 2.0
turnSignalBoolean@see TurnSignalNSubscribableSmartDeviceLink 5.0
cloudAppVehicleIDBooleanID for the vehicle when connecting to cloud applicationsNSubscribableSmartDeviceLink 5.1 SmartDeviceLink 2.0
turnSignalBoolean@see TurnSignalNSubscribableSmartDeviceLink 5.0
cloudAppVehicleIDBooleanID for the vehicle when connecting to cloud applicationsNSubscribableSmartDeviceLink 5.1
stabilityControlsStatusBooleanNSmartDeviceLink 7.0.0
handsOffSteeringBoolean
+ * * * *

Response

diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/HMIPermissions.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/HMIPermissions.java index 8b88366df..1349bb783 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/HMIPermissions.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/HMIPermissions.java @@ -43,34 +43,34 @@ import java.util.List; * Defining sets of HMI levels, which are permitted or prohibited for a given RPC. *

Parameter List

* - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * *
NameTypeDescriptionSmartDeviceLink Ver. Available
allowedHMILevelA set of all HMI levels that are permitted for this given RPC. - *
    - *
  • Min: 0
    • - *
  • Max: 100
    • - *
- * 		SmartDeviceLink 2.0
userDisallowedHMILevelA set of all HMI levels that are prohibited for this given RPC. - *
    - *
  • Min: 0
    • - *
  • Max: 100
    • - *
- * 		SmartDeviceLink 2.0
NameTypeDescriptionSmartDeviceLink Ver. Available
allowedHMILevelA set of all HMI levels that are permitted for this given RPC. + *
    + *
  • Min: 0
    • + *
  • Max: 100
    • + *
+ * 		SmartDeviceLink 2.0
userDisallowedHMILevelA set of all HMI levels that are prohibited for this given RPC. + *
    + *
  • Min: 0
    • + *
  • Max: 100
    • + *
+ * 		SmartDeviceLink 2.0
* * @since SmartDeviceLink 2.0 diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/Image.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/Image.java index dfa452e90..147b01d3b 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/Image.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/Image.java @@ -42,29 +42,29 @@ import java.util.Hashtable; * Specifies, which image shall be used, e.g. in Alerts or on SoftButtons provided the display supports it. *

Parameter List

* - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * *
NameTypeDescriptionSmartDeviceLink Ver. Available
valueStringEither the static hex icon value or the binary image file name identifier (sent by PutFile). - *
    - *
  • Min: 0
    • - *
  • Max: 65535
    • - *
- * 		SmartDeviceLink 2.0
imageTypeImageTypeDescribes, whether it is a static or dynamic image.SmartDeviceLink 2.0
NameTypeDescriptionSmartDeviceLink Ver. Available
valueStringEither the static hex icon value or the binary image file name identifier (sent by PutFile). + *
    + *
  • Min: 0
    • + *
  • Max: 65535
    • + *
+ * 		SmartDeviceLink 2.0
imageTypeImageTypeDescribes, whether it is a static or dynamic image.SmartDeviceLink 2.0
* * @since SmartDeviceLink 2.0 diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ImageField.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ImageField.java index a7a79fa1b..a1a19aefe 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ImageField.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ImageField.java @@ -45,38 +45,38 @@ import java.util.List; * *

Parameter List

* - * - * - * - * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * + * + * *
NameTypeDescription
NameTypeDescriptionReg.Notes Version
nameImageFieldNameThe name that identifies the field.{@linkplain ImageFieldName} Version
nameImageFieldNameThe name that identifies the field.{@linkplain ImageFieldName}SmartDeviceLink 3.0
imageTypeSupportedFileTypeThe image types that are supported in this field. {@linkplain FileType}SmartDeviceLink 3.0
imageTypeSupportedFileTypeThe image types that are supported in this field. {@linkplain FileType}maxlength: 100SmartDeviceLink 3.0
imageResolutionImageResolutionThe image resolution of this field.SmartDeviceLink 3.0
imageResolutionImageResolutionThe image resolution of this field.YSmartDeviceLink 3.0
SmartDeviceLink 3.0
* * @see com.smartdevicelink.proxy.rpc.enums.ImageType diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ImageResolution.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ImageResolution.java index b14e2ccba..20533d910 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ImageResolution.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ImageResolution.java @@ -43,30 +43,30 @@ import java.util.Hashtable; *

Parameter List

* * - * - * - * - * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * + * + * * *
NameTypeDescription
NameTypeDescriptionReg.NotesVersion
resolutionWidthIntegerThe image resolution width.Version
resolutionWidthIntegerThe image resolution width.minvalue:1; maxvalue: 10000SmartDeviceLink 3.0
resolutionHeightIntegerThe image resolution height.SmartDeviceLink 3.0
resolutionHeightIntegerThe image resolution height.minvalue:1; maxvalue: 10000SmartDeviceLink 3.0
SmartDeviceLink 3.0
* diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/KeyboardProperties.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/KeyboardProperties.java index a59623720..619eb8f4d 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/KeyboardProperties.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/KeyboardProperties.java @@ -45,84 +45,84 @@ import java.util.List; * *

Parameter List

* - * - * - * - * + * + * + * + * * - * - * - * - * - * - * + * + * + * + * + * + * * - * - * - * - * - * - * + * + * + * + * + * + * * - * - * - * - * - * - * + * + * + * + * + * + * * - * - * - * - * - * - * + * + * + * + * + * + * * - * - * - * - * - * - * + * + * + * + * + * + * * - * - * + * + * * - * - * - * - * + * + * + * + * * - * - * - * - * - * - * + * + * + * + * + * + * * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * *
NameTypeMandatory
NameTypeMandatory AdditionalDescription
languageLanguagefalseDescription
languageLanguagefalseThe keyboard language.
keyboardLayoutKeyboardLayoutfalseThe keyboard language.
keyboardLayoutKeyboardLayoutfalseDesired keyboard layout.
sendDynamicEntryBooleanfalseDesired keyboard layout.
sendDynamicEntryBooleanfalseIn this mode, all key presses will be sent as they occur. If disabled, entire string of text will be returned only once submitted by user.If omitted, this value will be set to FALSE.
keypressModeKeypressModeFalseIn this mode, all key presses will be sent as they occur. If disabled, entire string of text will be returned only once submitted by user.If omitted, this value will be set to FALSE.
keypressModeKeypressModeFalseDesired keypress mode.If omitted, this value will be set to RESEND_CURRENT_ENTRY.
limitedCharacterListStringfalseDesired keypress mode.If omitted, this value will be set to RESEND_CURRENT_ENTRY.
limitedCharacterListStringfalseArray = true maxLength = 1 minsize = 1 maxsize = 100Array of keyboard characters to enable. All omitted characters will be greyed out (disabled) on the keyboard. If omitted, the entire keyboard will be enabled.
Array of keyboard characters to enable. All omitted characters will be greyed out (disabled) on the keyboard. If omitted, the entire keyboard will be enabled.
autoCompleteTextStringfalse
autoCompleteTextStringfalsemaxlength = 1000 Allows an app to prepopulate the text field with a suggested or completed entry as the user types.
autoCompleteListStringfalseAllows an app to prepopulate the text field with a suggested or completed entry as the user types.
autoCompleteListStringfalseArray = true maxlength = 1000 minsize = 0 maxsize = 100Allows an app to prepopulate the text field with a list of suggested or completed entry as the user types. Set to an empty array to remove the auto-complete list from the screen
maskInputCharactersKeyboardInputMaskfalse - * @since SmartDeviceLink 7.1.0 - * Allows an app to mask entered characters on HMI
customKeysListfalse - * @since SmartDeviceLink 7.1.0 - * - * Array of special characters to show in customizable keys. If omitted, keyboard will show default special characters - * {"string_max_length": 1, "string_min_length": 1, "array_max_size": 10, "array_min_size": 1} - *
Allows an app to prepopulate the text field with a list of suggested or completed entry as the user types. Set to an empty array to remove the auto-complete list from the screen
maskInputCharactersKeyboardInputMaskfalse + * @since SmartDeviceLink 7.1.0 + * Allows an app to mask entered characters on HMI
customKeysListfalse + * @since SmartDeviceLink 7.1.0 + * + * Array of special characters to show in customizable keys. If omitted, keyboard will show default special characters + * {"string_max_length": 1, "string_min_length": 1, "array_max_size": 10, "array_min_size": 1} + *
* * @since SmartDeviceLink 3.0 diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/MenuParams.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/MenuParams.java index 4801930f7..727784651 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/MenuParams.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/MenuParams.java @@ -41,49 +41,49 @@ import java.util.Hashtable; * Used when adding a sub menu to an application menu or existing sub menu. *

Parameter List

* - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * * - * - * - * - * - * + * + * + * + * + * * * * @@ -173,10 +173,10 @@ public class MenuParams extends RPCStruct { * Get the position within the items of the parent Command Menu. 0 will insert at the front, 1 will insert after the first existing element, etc. * Position of any submenu will always be located before the return and exit options. *
    - *
  • Min Value: 0
    • - *
  • Max Value: 1000
    • - *
  • If position is greater or equal than the number of items in the parent Command Menu, the sub menu will be appended to the end of that Command Menu.
    • - *
  • If this element is omitted, the entry will be added at the end of the parent menu.
    • + *
  • Min Value: 0
    • + *
  • Max Value: 1000
    • + *
  • If position is greater or equal than the number of items in the parent Command Menu, the sub menu will be appended to the end of that Command Menu.
    • + *
  • If this element is omitted, the entry will be added at the end of the parent menu.
    • *
* * @return the position within the items of the parent Command Menu @@ -189,10 +189,10 @@ public class MenuParams extends RPCStruct { * Set the position within the items of the parent Command Menu. 0 will insert at the front, 1 will insert after the first existing element, etc. * Position of any submenu will always be located before the return and exit options. *
    - *
  • Min Value: 0
    • - *
  • Max Value: 1000
    • - *
  • If position is greater or equal than the number of items in the parent Command Menu, the sub menu will be appended to the end of that Command Menu.
    • - *
  • If this element is omitted, the entry will be added at the end of the parent menu.
    • + *
  • Min Value: 0
    • + *
  • Max Value: 1000
    • + *
  • If position is greater or equal than the number of items in the parent Command Menu, the sub menu will be appended to the end of that Command Menu.
    • + *
  • If this element is omitted, the entry will be added at the end of the parent menu.
    • *
* * @param position Mix: 0 Max: 1000 @@ -204,9 +204,9 @@ public class MenuParams extends RPCStruct { /** * Get the text which appears in menu, representing this command. - *
    - *
  • Min: 1
    • - *
  • Max: 100
    • + *
      + *
    • Min: 1
      • + *
    • Max: 100
      • *
    * * @return menuName the menu name @@ -218,9 +218,9 @@ public class MenuParams extends RPCStruct { /** * Set text which appears in menu, representing this command. - *
      - *
    • Min: 1
      • - *
    • Max: 100
      • + *
        + *
      • Min: 1
        • + *
      • Max: 100
        • *
      * * @param menuName the menu name diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/MyKey.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/MyKey.java index 319dca3c7..e98030756 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/MyKey.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/MyKey.java @@ -42,18 +42,18 @@ import java.util.Hashtable; * Information related to the MyKey feature. *

      Parameter List

      *
NameTypeDescriptionSmartDeviceLink Ver. Available
parentIDIntegerThe unique ID of an existing submenu to which a command will be added. - * If this element is not provided, the command will be added to the top level of the Command Menu. - *
    - *
  • Min: 0
    • - *
  • Max: 2000000000
    • - *
- * 		SmartDeviceLink 1.0
positionIntegerPosition within the items of the parent Command Menu. 0 will insert at the front, 1 will insert after the first existing element, etc. - * Position of any submenu will always be located before the return and exit options. - *
    - *
  • Min Value: 0
    • - *
  • Max Value: 1000
    • - *
  • If position is greater or equal than the number of items in the parent Command Menu, the sub menu will be appended to the end of that Command Menu.
    • - *
  • If this element is omitted, the entry will be added at the end of the parent menu.
    • - *
- * 		SmartDeviceLink 1.0
NameTypeDescriptionSmartDeviceLink Ver. Available
parentIDIntegerThe unique ID of an existing submenu to which a command will be added. + * If this element is not provided, the command will be added to the top level of the Command Menu. + *
    + *
  • Min: 0
    • + *
  • Max: 2000000000
    • + *
+ * 		SmartDeviceLink 1.0
positionIntegerPosition within the items of the parent Command Menu. 0 will insert at the front, 1 will insert after the first existing element, etc. + * Position of any submenu will always be located before the return and exit options. + *
    + *
  • Min Value: 0
    • + *
  • Max Value: 1000
    • + *
  • If position is greater or equal than the number of items in the parent Command Menu, the sub menu will be appended to the end of that Command Menu.
    • + *
  • If this element is omitted, the entry will be added at the end of the parent menu.
    • + *
+ * 		SmartDeviceLink 1.0
menuNameStringText which appears in menu, representing this command. - *
    - *
  • Min: 1
    • - *
  • Max: 100
    • - *
- * 		SmartDeviceLink 1.0
menuNameStringText which appears in menu, representing this command. + *
    + *
  • Min: 1
    • + *
  • Max: 100
    • + *
+ * 		SmartDeviceLink 1.0
secondaryTextString
- * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * *
Param NameTypeMandatoryDescription
e911OverrideVehicleDataStatustrueIndicates whether e911 override is on.
Param NameTypeMandatoryDescription
e911OverrideVehicleDataStatustrueIndicates whether e911 override is on.
* * @see GetVehicleData diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnHashChange.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnHashChange.java index e095c2d3d..df14be1ac 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnHashChange.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnHashChange.java @@ -44,22 +44,22 @@ import java.util.Hashtable; *

*

Parameter List

* - * - * - * - * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * + * + * *
NameTypeDescription
NameTypeDescriptionReg.NotesVersion
hashIDStringCalculated hash ID to be referenced during RegisterAppInterface.Version
hashIDStringCalculated hash ID to be referenced during RegisterAppInterface.Ymaxlength: 100SmartDeviceLink 3.0
SmartDeviceLink 3.0
* * @since SmartDeviceLink 3.0 diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnKeyboardInput.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnKeyboardInput.java index 496b912be..e155bedad 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnKeyboardInput.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnKeyboardInput.java @@ -44,30 +44,30 @@ import java.util.Hashtable; *

*

Parameter List

* - * - * - * - * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * + * + * * *
NameTypeDescription
NameTypeDescriptionReg.NotesVersion
eventKeyboardEventOn-screen keyboard input data.Version
eventKeyboardEventOn-screen keyboard input data.YSmartDeviceLink 3.0
dataStringOn-screen keyboard input data.For dynamic keypress events, this will be the current compounded string of entry text.For entry cancelled and entry aborted events, this data param will be omitted.SmartDeviceLink 3.0
dataStringOn-screen keyboard input data.For dynamic keypress events, this will be the current compounded string of entry text.For entry cancelled and entry aborted events, this data param will be omitted.Maxlength: 500SmartDeviceLink 3.0
SmartDeviceLink 3.0
*/ diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnSystemRequest.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnSystemRequest.java index ebe24268a..a2096ccf4 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnSystemRequest.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnSystemRequest.java @@ -52,71 +52,71 @@ import java.util.List; * *

Parameter List

* - * - * - * - * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * + * + * *
NameTypeDescription
NameTypeDescriptionReg.NotesVersion
requestTypeRequestTypeThe type of system request.Version
requestTypeRequestTypeThe type of system request.YSmartDeviceLink 2.3.2
requestSubTypeStringThis parameter is filled for supporting OEM proprietary data exchanges.SmartDeviceLink 2.3.2
requestSubTypeStringThis parameter is filled for supporting OEM proprietary data exchanges.NMax Length: 255SmartDeviceLink 5.0
urlArray of StringsOptional URL for HTTP requests.If blank, the binary data shall be forwarded to the app.If not blank, the binary data shall be forwarded to the url with a provided timeout in seconds.SmartDeviceLink 5.0
urlArray of StringsOptional URL for HTTP requests.If blank, the binary data shall be forwarded to the app.If not blank, the binary data shall be forwarded to the url with a provided timeout in seconds.Nminsize:1;SmartDeviceLink 2.3.2
timeoutIntegerOptional timeout for HTTP requests;Required if a URL is providedSmartDeviceLink 2.3.2
timeoutIntegerOptional timeout for HTTP requests;Required if a URL is providedNminvalue:0; maxvalue: 2000000000SmartDeviceLink
fileTypeFileTypeOptional file type (meant for HTTP file requests).SmartDeviceLink
fileTypeFileTypeOptional file type (meant for HTTP file requests).NSmartDeviceLink 2.3.2
offsetFloatOptional offset in bytes for resuming partial data chunksSmartDeviceLink 2.3.2
offsetFloatOptional offset in bytes for resuming partial data chunksNminvalue:0; maxvalue:100000000000SmartDeviceLink 2.3.2
lengthFloatOptional length in bytes for resuming partial data chunksSmartDeviceLink 2.3.2
lengthFloatOptional length in bytes for resuming partial data chunksNminvalue: 0; maxvalue:100000000000SmartDeviceLink 2.3.2
SmartDeviceLink 2.3.2
* * @since SmartDeviceLink 2.3.2 diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnTouchEvent.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnTouchEvent.java index 07bfa0393..509dee0e8 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnTouchEvent.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnTouchEvent.java @@ -45,30 +45,30 @@ import java.util.List; *

Parameter List

* * - * - * - * - * + * + * + * + * * * - * - * + * + * * - * - * - * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * + * + * *
NameTypeDescription
NameTypeDescriptionReg.NotesVersion
Version
typeTouchTypeThe type of touch event.typeTouchTypeThe type of touch event.YSmartDeviceLink 3.0
eventTouchEventList of all individual touches involved in this event.SmartDeviceLink 3.0
eventTouchEventList of all individual touches involved in this event.Yminsize:1; maxsize:10SmartDeviceLink 3.0
SmartDeviceLink 3.0
* *

Note:

diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnVehicleData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnVehicleData.java index 8d87f6d30..651349a82 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/OnVehicleData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/OnVehicleData.java @@ -59,86 +59,86 @@ import java.util.List; * *

Parameter List

* - * - * - * - * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * + * + * + * * * * @@ -160,151 +160,151 @@ import java.util.List; * * * - * - * - * - * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * + * + * + * * - * - * - * - * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * * * * diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ParameterPermissions.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ParameterPermissions.java index cd563bc64..26e80aa06 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ParameterPermissions.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ParameterPermissions.java @@ -42,36 +42,36 @@ import java.util.List; * Defining sets of parameters, which are permitted or prohibited for a given RPC. *

Parameter List

*
Param NameTypeDescription
Param NameTypeDescription Req.NotesVersion Available
GpsBooleanGPS data. See {@linkplain com.smartdevicelink.proxy.rpc.GPSData} for detailsNotesVersion Available
GpsBooleanGPS data. See {@linkplain com.smartdevicelink.proxy.rpc.GPSData} for detailsNSubscribable SmartDeviceLink 2.0
SpeedFloatThe vehicle speed in kilometers per hourSubscribable SmartDeviceLink 2.0
SpeedFloatThe vehicle speed in kilometers per hourNSubscribableSmartDeviceLink 2.0
rpmIntegerThe number of revolutions per minute of the engineSubscribableSmartDeviceLink 2.0
rpmIntegerThe number of revolutions per minute of the engineNSubscribableSmartDeviceLink 2.0
fuelLevelBooleanThe fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec7.0, please see fuelRange.SubscribableSmartDeviceLink 2.0
fuelLevelBooleanThe fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec7.0, please see fuelRange.NSubscribableSmartDeviceLink 7.0.0
fuelLevel_StateBooleanThe fuel level state. This parameter is deprecated starting RPC Spec 7.0, please see fuelRange.SubscribableSmartDeviceLink 7.0.0
fuelLevel_StateBooleanThe fuel level state. This parameter is deprecated starting RPC Spec 7.0, please see fuelRange.NSubscribableSmartDeviceLink 7.0.0
fuelRangeBooleanThe fuel type, estimated range in KM, fuel level/capacity and fuel level state for the vehicle. See struct FuelRange for details.N{"array_min_size": 0, "array_max_size": 100}SmartDeviceLink 5.0.0
instantFuelConsumptionFloatThe instantaneous fuel consumption in micro litresSubscribableSmartDeviceLink 7.0.0
fuelRangeBooleanThe fuel type, estimated range in KM, fuel level/capacity and fuel level state for the vehicle. See struct FuelRange for details.N{"array_min_size": 0, "array_max_size": 100}SmartDeviceLink 5.0.0
instantFuelConsumptionFloatThe instantaneous fuel consumption in micro litresNSubscribable SmartDeviceLink 2.0
externalTemperatureFloatThe external temperature in degrees celsius.Subscribable SmartDeviceLink 2.0
externalTemperatureFloatThe external temperature in degrees celsius.NSubscribable SmartDeviceLink 2.0
vinStringVehicle identification number.Subscribable SmartDeviceLink 2.0
vinStringVehicle identification number.NSubscribable SmartDeviceLink 2.0
Subscribable SmartDeviceLink 2.0
gearStatusGearStatusNSmartDeviceLink 7.0.0
tirePressureTireStatusTire pressure status
tirePressureTireStatusTire pressure statusNSubscribableSmartDeviceLink 2.0
odometerIntegerOdometer in kmSubscribableSmartDeviceLink 2.0
odometerIntegerOdometer in kmNSubscribable SmartDeviceLink 2.0
beltStatusBeltStatusThe status of the seat belts.Subscribable SmartDeviceLink 2.0
beltStatusBeltStatusThe status of the seat belts.NSubscribable SmartDeviceLink 2.0
bodyInformationBodyInformationThe body information including power modes.Subscribable SmartDeviceLink 2.0
bodyInformationBodyInformationThe body information including power modes.NSubscribableSmartDeviceLink 2.0
deviceStatusDeviceStatusThe connected mobile device status including signal and battery strength.SubscribableSmartDeviceLink 2.0
deviceStatusDeviceStatusThe connected mobile device status including signal and battery strength.NSubscribableSmartDeviceLink 2.0
eCallInfoECallInfoEmergency Call notification and confirmation data.SubscribableSmartDeviceLink 2.0
eCallInfoECallInfoEmergency Call notification and confirmation data.NSubscribableSmartDeviceLink 2.0
airbagStatusAirBagStatusThe status of the air bags.SubscribableSmartDeviceLink 2.0
airbagStatusAirBagStatusThe status of the air bags.NSubscribableSmartDeviceLink 2.0
emergencyEventEmergencyEventInformation related to an emergency event (and if it occurred).SubscribableSmartDeviceLink 2.0
emergencyEventEmergencyEventInformation related to an emergency event (and if it occurred).NSubscribableSmartDeviceLink 2.0
clusterModeStatusClusterModeStatusThe status modes of the instrument panel cluster.SubscribableSmartDeviceLink 2.0
clusterModeStatusClusterModeStatusThe status modes of the instrument panel cluster.NSubscribableSmartDeviceLink 2.0
myKeyMyKeyInformation related to the MyKey feature.SubscribableSmartDeviceLink 2.0
myKeyMyKeyInformation related to the MyKey feature.NSubscribableSmartDeviceLink 2.0
SubscribableSmartDeviceLink 2.0
driverBrakingvehicleDataEventStatusThe status of the brake pedal.
driverBrakingvehicleDataEventStatusThe status of the brake pedal.NSubscribableSmartDeviceLink 2.0
wiperStatusWiperStatusThe status of the wipersSubscribableSmartDeviceLink 2.0
wiperStatusWiperStatusThe status of the wipersN SmartDeviceLink 2.0
headLampStatusheadLampStatusStatus of the head lamps SmartDeviceLink 2.0
headLampStatusheadLampStatusStatus of the head lampsNSmartDeviceLink 2.0
engineTorqueFloatTorque value for engine (in Nm) on non-diesel variantsSmartDeviceLink 2.0
engineTorqueFloatTorque value for engine (in Nm) on non-diesel variantsNminvalue:-1000; maxvalue:2000SmartDeviceLink 2.0
engineOilLifeFloatThe estimated percentage of remaining oil life of the engineminvalue:-1000; maxvalue:2000SmartDeviceLink 2.0
engineOilLifeFloatThe estimated percentage of remaining oil life of the engineNminvalue:0; maxvalue:100SmartDeviceLink 5.0
accPedalPositionFloatAccelerator pedal position (percentage depressed)minvalue:0; maxvalue:100SmartDeviceLink 5.0
accPedalPositionFloatAccelerator pedal position (percentage depressed)Nminvalue: 0; maxvalue:100SmartDeviceLink 2.0
steeringWheelAngleFloatCurrent angle of the steering wheel (in deg)minvalue: 0; maxvalue:100SmartDeviceLink 2.0
steeringWheelAngleFloatCurrent angle of the steering wheel (in deg)N minvalue: -2000; maxvalue:2000SmartDeviceLink 2.0
cloudAppVehicleIDStringID for the vehicle when connecting to cloud applicationsNSmartDeviceLink 5.1
minvalue: -2000; maxvalue:2000SmartDeviceLink 2.0
cloudAppVehicleIDStringID for the vehicle when connecting to cloud applicationsNSmartDeviceLink 5.1
handsOffSteeringBoolean
- * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * *
NameTypeDescriptionSmartDeviceLink Ver. Available
allowedStringA set of all parameters that are permitted for this given RPC. - *
    - *
  • Min size: 0
    • - *
  • Max size: 100
    • - *
  • Max length: 100
    • - *
- * 		SmartDeviceLink 2.0
userDisallowedStringA set of all parameters that are prohibited for this given RPC. - *
    - *
  • Min size: 0
    • - *
  • Max size: 100
    • - *
  • Max length: 100
    • - *
- * 		SmartDeviceLink 2.0
NameTypeDescriptionSmartDeviceLink Ver. Available
allowedStringA set of all parameters that are permitted for this given RPC. + *
    + *
  • Min size: 0
    • + *
  • Max size: 100
    • + *
  • Max length: 100
    • + *
+ * 		SmartDeviceLink 2.0
userDisallowedStringA set of all parameters that are prohibited for this given RPC. + *
    + *
  • Min size: 0
    • + *
  • Max size: 100
    • + *
  • Max length: 100
    • + *
+ * 		SmartDeviceLink 2.0
* * @since SmartDeviceLink 2.0 diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformAudioPassThru.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformAudioPassThru.java index 088ef5c8e..dea5997d1 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformAudioPassThru.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformAudioPassThru.java @@ -52,70 +52,70 @@ import java.util.List; * *

Parameter List

* - * - * - * - * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * + * + * * * * diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformInteraction.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformInteraction.java index adbb09e52..1a1c254b4 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformInteraction.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/PerformInteraction.java @@ -56,94 +56,94 @@ import java.util.List; * *

Parameter List

*
NameTypeDescription
NameTypeDescriptionReg.Notes Version
initialPromptTTSChunk[]SDL will speak this prompt before opening the audio pass thru session. Version
initialPromptTTSChunk[]SDL will speak this prompt before opening the audio pass thru session. NThis is an array of text chunks of type TTSChunk. The array must have at least one item If omitted, then no initial prompt is spoken:

Array Minsize: 1

Array Maxsize: 100		SmartDeviceLink 2.0
audioPassThruDisplayText1StringFirst line of text displayed during audio capture.SmartDeviceLink 2.0
audioPassThruDisplayText1StringFirst line of text displayed during audio capture.NMaxlength = 500SmartDeviceLink 2.0
samplingRateSamplingRateThis value shall is allowed to be 8 or 16 or 22 or 44 khz.SmartDeviceLink 2.0
samplingRateSamplingRateThis value shall is allowed to be 8 or 16 or 22 or 44 khz.YSmartDeviceLink 2.0
maxDurationIntegerThe maximum duration of audio recording in milliseconds.SmartDeviceLink 2.0
maxDurationIntegerThe maximum duration of audio recording in milliseconds.YMinvalue: 1; Maxvalue: 1000000SmartDeviceLink 2.0
bitsPerSampleBitsPerSampleSpecifies the quality the audio is recorded - 8 bit or 16 bit.SmartDeviceLink 2.0
bitsPerSampleBitsPerSampleSpecifies the quality the audio is recorded - 8 bit or 16 bit.YSmartDeviceLink 2.0
audioTypeAudioTypeSpecifies the type of audio data being requested.SmartDeviceLink 2.0
audioTypeAudioTypeSpecifies the type of audio data being requested.YSmartDeviceLink 2.0
muteAudioBooleanNSmartDeviceLink 2.0
muteAudioBooleanNNSmartDeviceLink 2.0
SmartDeviceLink 2.0
- * - * - * - * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * + * + * + * *
Param NameTypeDescription
Param NameTypeDescription Req.NotesVersion Available
initialTextStringDisplayed when the interaction begins. This text may be overlaid by the "Listening" prompt during the interaction. Text is displayed on first line of multiline display, and is centered. If text does not fit on line, it will be truncatedNotesVersion Available
initialTextStringDisplayed when the interaction begins. This text may be overlaid by the "Listening" prompt during the interaction. Text is displayed on first line of multiline display, and is centered. If text does not fit on line, it will be truncatedYmaxlength:500SmartDeviceLink 1.0
initialPromptTTSChunkAn array of one or more TTSChunks that, taken together, specify what is to be spoken to the user at the start of an interaction.maxlength:500SmartDeviceLink 1.0
initialPromptTTSChunkAn array of one or more TTSChunks that, taken together, specify what is to be spoken to the user at the start of an interaction.Yminsize:1; maxsize:100SmartDeviceLink 1.0
interactionModeInteractionModeIndicates how user selects interaction choice. User can choose either by voice (VR_ONLY), by visual selection from the menu (MANUAL_ONLY), or by either mode (BOTH). minsize:1; maxsize:100SmartDeviceLink 1.0
interactionModeInteractionModeIndicates how user selects interaction choice. User can choose either by voice (VR_ONLY), by visual selection from the menu (MANUAL_ONLY), or by either mode (BOTH). YSmartDeviceLink 1.0
interactionChoiceSetIDListIntegerArray of one or more Choice Set IDs. User can select any choice from any of the specified Choice Sets.SmartDeviceLink 1.0
interactionChoiceSetIDListIntegerArray of one or more Choice Set IDs. User can select any choice from any of the specified Choice Sets.Yminsize:0; maxsize:100; minvalue:0; maxvalue:2000000000SmartDeviceLink 1.0
helpPromptTTSChunkAn array of TTSChunks which, taken together, specify the help phrase to be spoken when the user says "help" during the VR session. If this parameter is omitted, the help prompt will be constructed by SDL from the first vrCommand of each choice of all the Choice Sets specified in the interactionChoiceSetIDList parameter. minsize:0; maxsize:100; minvalue:0; maxvalue:2000000000SmartDeviceLink 1.0
helpPromptTTSChunkAn array of TTSChunks which, taken together, specify the help phrase to be spoken when the user says "help" during the VR session. If this parameter is omitted, the help prompt will be constructed by SDL from the first vrCommand of each choice of all the Choice Sets specified in the interactionChoiceSetIDList parameter. Nminsize:1; maxsize:100; The helpPrompt specified in SetGlobalProperties is not used by PerformInteraction.SmartDeviceLink 1.0
timeoutPromptTTSChunkAn array of TTSChunks which, taken together, specify the phrase to be spoken when the listen times out during the VR session. If this parameter is omitted, the timeout prompt will be the same as the help prompt (see helpPrompt parameter). minsize:1; maxsize:100; The helpPrompt specified in SetGlobalProperties is not used by PerformInteraction.SmartDeviceLink 1.0
timeoutPromptTTSChunkAn array of TTSChunks which, taken together, specify the phrase to be spoken when the listen times out during the VR session. If this parameter is omitted, the timeout prompt will be the same as the help prompt (see helpPrompt parameter). NThe timeoutPrompt specified in SetGlobalProperties is not used by PerformInteraction. minsize:1;maxsize:100SmartDeviceLink 1.0
timeoutIntegerThe amount of time, in milliseconds, SDL will wait for the user to make a choice (VR or Menu). If this time elapses without the user making a choice, the timeoutPrompt will be spoken. After this timeout value has been reached, the interaction will stop and a subsequent interaction will take place after SDL speaks the timeout prompt. If that times out as well, the interaction will end completely. If omitted, the default is 10000ms.The timeoutPrompt specified in SetGlobalProperties is not used by PerformInteraction. minsize:1;maxsize:100SmartDeviceLink 1.0
timeoutIntegerThe amount of time, in milliseconds, SDL will wait for the user to make a choice (VR or Menu). If this time elapses without the user making a choice, the timeoutPrompt will be spoken. After this timeout value has been reached, the interaction will stop and a subsequent interaction will take place after SDL speaks the timeout prompt. If that times out as well, the interaction will end completely. If omitted, the default is 10000ms.Nminvalue:5000; maxvalue:100000; defvalue:10000SmartDeviceLink 1.0
vrHelpVrHelpItemAbility to send suggested VR Help Items to display on-screen during Perform Interaction If omitted on supported displays, the default SDL generated list of suggested choices will be displayed.minvalue:5000; maxvalue:100000; defvalue:10000SmartDeviceLink 1.0
vrHelpVrHelpItemAbility to send suggested VR Help Items to display on-screen during Perform Interaction If omitted on supported displays, the default SDL generated list of suggested choices will be displayed.NMin = 1;Max = 100SmartDeviceLink 2.0
interactionLayoutLayoutModeSee {@linkplain LayoutMode}Min = 1;Max = 100SmartDeviceLink 2.0
interactionLayoutLayoutModeSee {@linkplain LayoutMode}NSmartDeviceLink 3.0
cancelIDIntegerAn ID for this specific perform interaction to allow cancellation through the `CancelInteraction` RPC.SmartDeviceLink 3.0
cancelIDIntegerAn ID for this specific perform interaction to allow cancellation through the `CancelInteraction` RPC.NSmartDeviceLink 6.0
SmartDeviceLink 6.0
* * @see CreateInteractionChoiceSet diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/PermissionItem.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/PermissionItem.java index d7d902c5c..473cd409f 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/PermissionItem.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/PermissionItem.java @@ -43,39 +43,39 @@ import java.util.Hashtable; * *

Parameter List

* - * - * - * - * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * + * + * + * * - * - * - * - * + * + * + * + * * - * - * - * + * + * + * *
Param NameTypeDescription
Param NameTypeDescription Req.NotesVersion Available
rpcNameStringName of the individual RPC in the policy table.NotesVersion Available
rpcNameStringName of the individual RPC in the policy table.maxlength:100SmartDeviceLink 2.0
hmiPermissionsHMIPermissionsSets of parameters, which are permitted or prohibited for the given RPC.maxlength:100SmartDeviceLink 2.0
hmiPermissionsHMIPermissionsSets of parameters, which are permitted or prohibited for the given RPC.SmartDeviceLink 2.0
SmartDeviceLink 2.0
parameterPermissionsParameterPermissionsSets of parameters, which are permitted or prohibited for the given RPC.
parameterPermissionsParameterPermissionsSets of parameters, which are permitted or prohibited for the given RPC.SmartDeviceLink 2.0
SmartDeviceLink 2.0
* * @since SmartDeviceLink 2.0 diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/PresetBankCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/PresetBankCapabilities.java index 1efdcc75f..260cfb26a 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/PresetBankCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/PresetBankCapabilities.java @@ -41,19 +41,19 @@ import java.util.Hashtable; * Contains information about on-screen preset capabilities. *

Parameter List

* - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * *
NameTypeDescriptionSmartDeviceLink Ver. Available
onScreenPresetsAvailableBooleanDefines, if Onscreen custom presets are available. - * SmartDeviceLink 2.0
NameTypeDescriptionSmartDeviceLink Ver. Available
onScreenPresetsAvailableBooleanDefines, if Onscreen custom presets are available. + * SmartDeviceLink 2.0
* * @since SmartDeviceLink 2.0 diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/PutFile.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/PutFile.java index 0c37d25ea..3041c9c06 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/PutFile.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/PutFile.java @@ -47,70 +47,70 @@ import java.util.zip.CRC32; *

Parameter List

* * - * - * - * - * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * + * + * + * *
NameTypeDescription
NameTypeDescription Req.NotesVersion Available
FileNameStringFile reference name.NotesVersion Available
FileNameStringFile reference name.YMaxlength=500SmartDeviceLink 2.0
fileTypeFileTypeSelected file type.Maxlength=500SmartDeviceLink 2.0
fileTypeFileTypeSelected file type.YSmartDeviceLink 2.0
persistentFileBooleanIndicates if the file is meant to persist between sessions / ignition cycles. If set to TRUE,then the system will aim to persist this file through session / cycles. While files with this designation will have priority over others,they are subject to deletion by the system at any time.In the event of automatic deletion by the system, the app will receive a rejection and have to resend the file. If omitted, the value will be set to false.SmartDeviceLink 2.0
persistentFileBooleanIndicates if the file is meant to persist between sessions / ignition cycles. If set to TRUE,then the system will aim to persist this file through session / cycles. While files with this designation will have priority over others,they are subject to deletion by the system at any time.In the event of automatic deletion by the system, the app will receive a rejection and have to resend the file. If omitted, the value will be set to false.NSmartDeviceLink 2.0
systemFileBooleanIndicates if the file is meant to be passed thru core to elsewhere on the system. If set to TRUE, then the system will instead pass the data thru as it arrives to a predetermined area outside of core. If omitted, the value will be set to false.SmartDeviceLink 2.0
systemFileBooleanIndicates if the file is meant to be passed thru core to elsewhere on the system. If set to TRUE, then the system will instead pass the data thru as it arrives to a predetermined area outside of core. If omitted, the value will be set to false.NSmartDeviceLink 2.3.2
offsetFloatOptional offset in bytes for resuming partial data chunksSmartDeviceLink 2.3.2
offsetFloatOptional offset in bytes for resuming partial data chunksNMinvalue=0; Maxvalue=100000000000SmartDeviceLink 2.3.2
lengthFloatOptional length in bytes for resuming partial data chunks. If offset is set to 0, then length is the total length of the file to be downloadedMinvalue=0; Maxvalue=100000000000SmartDeviceLink 2.3.2
lengthFloatOptional length in bytes for resuming partial data chunks. If offset is set to 0, then length is the total length of the file to be downloadedNMinvalue=0; Maxvalue=100000000000SmartDeviceLink 2.3.2
crcLongAdditional CRC32 checksum to protect data integrity up to 512 Mbits .Minvalue=0; Maxvalue=100000000000SmartDeviceLink 2.3.2
crcLongAdditional CRC32 checksum to protect data integrity up to 512 Mbits .Nminvalue="0" maxvalue="4294967295"SmartDeviceLink 2.3.2
minvalue="0" maxvalue="4294967295"SmartDeviceLink 2.3.2
*

Note:

* When using PutFiles you may want to check for memory @@ -118,32 +118,32 @@ import java.util.zip.CRC32; *

Response

* Response is sent, when the file data was copied (success case). Or when an error occurred. Not supported on First generation SDL modules. * - *

Non-default Result Codes:

- *

SUCCESS

- *

INVALID_DATA

- *

OUT_OF_MEMORY

- *

TOO_MANY_PENDING_REQUESTS

- *

APPLICATION_NOT_REGISTERED

- *

GENERIC_ERROR

- *

REJECTED

+ *

Non-default Result Codes:

+ *

SUCCESS

+ *

INVALID_DATA

+ *

OUT_OF_MEMORY

+ *

TOO_MANY_PENDING_REQUESTS

+ *

APPLICATION_NOT_REGISTERED

+ *

GENERIC_ERROR

+ *

REJECTED

* *

- * - * - * - * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * + * + * + * * *
NameTypeDescription
NameTypeDescription Req.NotesVersion Available
spaceAvailableIntegerProvides the total local space available on SDL for the registered app.NotesVersion Available
spaceAvailableIntegerProvides the total local space available on SDL for the registered app.Minvalue=0; Maxvalue=2000000000SmartDeviceLink 2.0
Minvalue=0; Maxvalue=2000000000SmartDeviceLink 2.0
* diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/RGBColor.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/RGBColor.java index 84393121a..b09558d55 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/RGBColor.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/RGBColor.java @@ -39,34 +39,34 @@ import java.util.Hashtable; * A color class that stores RGB values *

Parameter List

* - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * *
NameTypeReg.NotesVersion Available
redIntegerY
  • minvalue="0"
  • maxvalue="255"
SmartDeviceLink 5.0
greenIntegerY
  • minvalue="0"
  • maxvalue="255"
SmartDeviceLink 5.0
blueIntegerY
  • minvalue="0"
  • maxvalue="255"
SmartDeviceLink 5.0
NameTypeReg.NotesVersion Available
redIntegerY
  • minvalue="0"
  • maxvalue="255"
SmartDeviceLink 5.0
greenIntegerY
  • minvalue="0"
  • maxvalue="255"
SmartDeviceLink 5.0
blueIntegerY
  • minvalue="0"
  • maxvalue="255"
SmartDeviceLink 5.0
* * @since SmartDeviceLink 5.0 diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ReadDID.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ReadDID.java index 91d95c848..ad20efb1b 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ReadDID.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ReadDID.java @@ -50,38 +50,38 @@ import java.util.List; * *

Parameter List

* - * - * - * - * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * + * + * + * * - * - * - * - * + * + * + * + * * - * - * - * - * - * - * + * + * + * + * + * + * * - * - * - * + * + * + * *
Param NameTypeDescription
Param NameTypeDescription Req.NotesVersion Available
ecuNameIntegerName of ECU.NotesVersion Available
ecuNameIntegerName of ECU.YMinvalue: 0; Maxvalue: 65535SmartDeviceLink 2.0
Minvalue: 0; Maxvalue: 65535SmartDeviceLink 2.0
didLocationIntegerGet raw data from vehicle data DID location(s).
didLocationIntegerGet raw data from vehicle data DID location(s).YMinvalue: 0; Maxvalue: 65535SmartDeviceLink 2.0
appIDIntegerID of the application that requested this RPC.Minvalue: 0; Maxvalue: 65535SmartDeviceLink 2.0
appIDIntegerID of the application that requested this RPC.YSmartDeviceLink 2.0
SmartDeviceLink 2.0
* *

Response

@@ -128,8 +128,8 @@ public class ReadDID extends RPCRequest { * @param didLocation a List value representing raw data from vehicle data DID location(s)
* Notes: *
    - *
  • Minvalue:0; Maxvalue:65535
    • - *
  • ArrayMin:0; ArrayMax:1000
    • + *
  • Minvalue:0; Maxvalue:65535
    • + *
  • ArrayMin:0; ArrayMax:1000
    • *
*/ public ReadDID(@NonNull Integer ecuName, @NonNull List didLocation) { diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/RegisterAppInterface.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/RegisterAppInterface.java index 311095cea..5d7586d5c 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/RegisterAppInterface.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/RegisterAppInterface.java @@ -111,170 +111,170 @@ import java.util.List; * *

Parameter List

* - * - * - * - * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * + * + * * - * - * - * - * + * + * + * + * * * - * - * + * + * * - * - * - * - * + * + * + * + * * * - * - * + * + * * - * - * - * - * + * + * + * + * * * - * - * + * + * * - * - * - * - * + * + * + * + * * * - * - * + * + * *
NameTypeDescription
NameTypeDescriptionReg.NotesVersion
MsgVersionMsgVersionDeclares what version of the SDL interface the application expects to use with SDLVersion
MsgVersionMsgVersionDeclares what version of the SDL interface the application expects to use with SDLYTo be compatible, app msg major version number must be less than or equal to SDL major version number.

If msg versions are incompatible, app has 20 seconds to attempt successful RegisterAppInterface (w.r.t. msg version) on underlying protocol session, else will be terminated. Major version number is a compatibility declaration. Minor version number indicates minor functional variations (e.g. features, capabilities, bug fixes) when sent from SDL to app (in RegisterAppInterface response).

However, the minor version number sent from the app to SDL (in RegisterAppInterface request) is ignored by SDL.		SmartDeviceLink 1.0
appNameStringThe mobile application's name. This name is displayed in the SDL Mobile Applications menu. It also serves as the unique identifier of the application for SDL .SmartDeviceLink 1.0
appNameStringThe mobile application's name. This name is displayed in the SDL Mobile Applications menu. It also serves as the unique identifier of the application for SDL .Y

Must be 1-100 characters in length. Must consist of following characters:

May not be the same (by case insensitive comparison) as the name or any synonym of any currently registered application.

SmartDeviceLink 1.0
ttsNameTTSChunkTTS string for VR recognition of the mobile application name. Meant to overcome any failing on speech engine in properly pronouncing / understanding app name.SmartDeviceLink 1.0
ttsNameTTSChunkTTS string for VR recognition of the mobile application name. Meant to overcome any failing on speech engine in properly pronouncing / understanding app name.N

Size must be 1-100 Needs to be unique over all applications. May not be empty.

May not start with a new line character.

SmartDeviceLink 2.0
ngnMediaScreenAppNameStringProvides an abbreviated version of the app name (if necessary) that will be displayed on the NGN media screen.SmartDeviceLink 2.0
ngnMediaScreenAppNameStringProvides an abbreviated version of the app name (if necessary) that will be displayed on the NGN media screen.N- Must be 1-5 characters. If not provided, value will be derived from appName truncated to 5 characters.SmartDeviceLink 1.0
vrSynonymsStringAn array of 1-100 elements, each element containing a voice-recognition synonym by which this app can be called when being addressed in the mobile applications menu.SmartDeviceLink 1.0
vrSynonymsStringAn array of 1-100 elements, each element containing a voice-recognition synonym by which this app can be called when being addressed in the mobile applications menu.NEach vr synonym is limited to 40 characters, and there can be 1-100 synonyms in array. May not be the same (by case insensitive comparison) as the name or any synonym of any currently-registered application.SmartDeviceLink 1.0
isMediaApplicationBooleanIndicates that the application will be streaming audio to SDL (via A2DP) that is audible outside of the BT media source.SmartDeviceLink 1.0
isMediaApplicationBooleanIndicates that the application will be streaming audio to SDL (via A2DP) that is audible outside of the BT media source.YSmartDeviceLink 1.0
languageDesiredLanguageAn enumeration indicating what language the application intends to use for user interaction (Display, TTS and VR).SmartDeviceLink 1.0
languageDesiredLanguageAn enumeration indicating what language the application intends to use for user interaction (Display, TTS and VR).YIf the language indicated does not match the active language on SDL, the interface registration will be rejected.If the user changes the SDL language while this interface registration is active, the interface registration will be terminated. SmartDeviceLink 1.0
hmiDisplayLanguageDesiredLanguageAn enumeration indicating what language the application intends to use for user interaction ( Display).SmartDeviceLink 1.0
hmiDisplayLanguageDesiredLanguageAn enumeration indicating what language the application intends to use for user interaction ( Display).YSmartDeviceLink 2.0
appHMITypeAppHMITypeList of all applicable app types stating which classifications to be given to the app.e.g. for platforms , like GEN2, this will determine which "corner(s)" the app can populateSmartDeviceLink 2.0
appHMITypeAppHMITypeList of all applicable app types stating which classifications to be given to the app.e.g. for platforms , like GEN2, this will determine which "corner(s)" the app can populateNArray Minsize: 1; Array Maxsize: 100SmartDeviceLink 2.0
hashIDStringID used to uniquely identify current state of all app data that can persist through connection cycles (e.g. ignition cycles).This registered data (commands, submenus, choice sets, etc.) can be reestablished without needing to explicitly reregister each piece. If omitted, then the previous state of an app's commands, etc. will not be restored.When sending hashID, all RegisterAppInterface parameters should still be provided (e.g. ttsName, etc.). SmartDeviceLink 2.0
hashIDStringID used to uniquely identify current state of all app data that can persist through connection cycles (e.g. ignition cycles).This registered data (commands, submenus, choice sets, etc.) can be reestablished without needing to explicitly reregister each piece. If omitted, then the previous state of an app's commands, etc. will not be restored.When sending hashID, all RegisterAppInterface parameters should still be provided (e.g. ttsName, etc.). NmaxLength:100SmartDeviceLink 2.3.1
appInfoAppInfoSee AppInfo.SmartDeviceLink 2.3.1
appInfoAppInfoSee AppInfo.N@since SmartDeviceLink 4.2.0
deviceInfoDeviceInfoVarious information about connecting device.@since SmartDeviceLink 4.2.0
deviceInfoDeviceInfoVarious information about connecting device.NSmartDeviceLink 2.3.1
appIDStringID used to validate app with policy table entriesSmartDeviceLink 2.3.1
appIDStringID used to validate app with policy table entriesYmaxLength: 100SmartDeviceLink 2.0
fullAppIDStringID used to validate app with policy table entriesSmartDeviceLink 2.0
fullAppIDStringID used to validate app with policy table entriesNMaxlength: 100SmartDeviceLink 5.0
hmiCapabilitiesHMICapabilitiesSpecifies the HMI capabilities.SmartDeviceLink 5.0
hmiCapabilitiesHMICapabilitiesSpecifies the HMI capabilities.NSmartDeviceLink 2.3.2.2
SmartDeviceLink 2.3.2.2
sdlVersionStringThe SmartDeviceLink version.
sdlVersionStringThe SmartDeviceLink version.NMaxlength: 100SmartDeviceLink 2.3.2.2
SmartDeviceLink 2.3.2.2
systemSoftwareVersionStringThe software version of the system that implements the SmartDeviceLink core.
systemSoftwareVersionStringThe software version of the system that implements the SmartDeviceLink core.NMaxlength: 100SmartDeviceLink 2.3.2.2
SmartDeviceLink 2.3.2.2
dayColorSchemeTemplateColorSchemeThe color scheme that is used for day.
dayColorSchemeTemplateColorSchemeThe color scheme that is used for day.NSmartDeviceLink 5.0
SmartDeviceLink 5.0
nightColorSchemeTemplateColorSchemeThe color scheme that is used for night.
nightColorSchemeTemplateColorSchemeThe color scheme that is used for night.NSmartDeviceLink 5.0
SmartDeviceLink 5.0
*

* diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ResetGlobalProperties.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ResetGlobalProperties.java index ef84adc85..f845d4c03 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ResetGlobalProperties.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ResetGlobalProperties.java @@ -55,22 +55,22 @@ import java.util.List; * *

Parameter List

* - * - * - * - * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * + * + * + * * *
Param NameTypeDescription
Param NameTypeDescription Req.NotesVersion Available
propertiesGlobalPropertyAn array of one or more GlobalProperty enumeration elements indicating which global properties to reset to their default value.NotesVersion Available
propertiesGlobalPropertyAn array of one or more GlobalProperty enumeration elements indicating which global properties to reset to their default value.YArray must have at least one element.; minsize:1; maxsize:100SmartDeviceLink 1.0
Array must have at least one element.; minsize:1; maxsize:100SmartDeviceLink 1.0
*

Response

@@ -79,14 +79,14 @@ import java.util.List; * *

Non-default Result Codes:

* - *

SUCCESS

- *

INVALID_DATA

- *

OUT_OF_MEMORY

- *

TOO_MANY_PENDING_REQUESTS

- *

APPLICATION_NOT_REGISTERED

- *

GENERIC_ERROR

- *

REJECTED

- *

DISALLOWED

+ *

SUCCESS

+ *

INVALID_DATA

+ *

OUT_OF_MEMORY

+ *

TOO_MANY_PENDING_REQUESTS

+ *

APPLICATION_NOT_REGISTERED

+ *

GENERIC_ERROR

+ *

REJECTED

+ *

DISALLOWED

* * @see SetGlobalProperties * @since SmartDeviceLink 1.0 diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ScreenParams.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ScreenParams.java index 5f1d049f0..ef02964d4 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ScreenParams.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ScreenParams.java @@ -42,30 +42,30 @@ import java.util.Hashtable; * *

Parameter List

* - * - * - * - * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * + * + * + * * *
Param NameTypeDescription
Param NameTypeDescription Req.NotesVersion Available
resolutionImageResolutionThe resolution of the prescribed screen area.NotesVersion Available
resolutionImageResolutionThe resolution of the prescribed screen area.YSmartDeviceLink 2.3.2
touchEventAvailableTouchEventCapabilitiesTypes of screen touch events available in screen area.SmartDeviceLink 2.3.2
touchEventAvailableTouchEventCapabilitiesTypes of screen touch events available in screen area.NSmartDeviceLink 2.3.2
SmartDeviceLink 2.3.2
* diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/ScrollableMessage.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/ScrollableMessage.java index 019b3d55f..644c1708b 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/ScrollableMessage.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/ScrollableMessage.java @@ -51,60 +51,60 @@ import java.util.List; * *

Parameter List

* - * - * - * - * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * - * - * - * + * + * + * *
NameTypeDescription
NameTypeDescriptionReg.NotesVersion
scrollableMessageBodyStringBody of text that can include newlines and tabs.Version
scrollableMessageBodyStringBody of text that can include newlines and tabs.YSmartDevice Link 1.0
timeoutIntegerApp defined timeout. Indicates how long of a timeout from the last action (i.e. scrolling message resets timeout).SmartDevice Link 1.0
timeoutIntegerApp defined timeout. Indicates how long of a timeout from the last action (i.e. scrolling message resets timeout).NminValue=1000; maxValue=65535; defValue=30000SmartDevice Link 1.0
softButtonsSoftButtonApp defined SoftButtons. If omitted on supported displays, only the system defined "Close" SoftButton will be displayed.SmartDevice Link 1.0
softButtonsSoftButtonApp defined SoftButtons. If omitted on supported displays, only the system defined "Close" SoftButton will be displayed.Nminsize=0; maxsize=8SmartDevice Link 1.0
cancelIDIntegerAn ID for this specific ScrollableMessage to allow cancellation through the `CancelInteraction` RPC.SmartDevice Link 1.0
cancelIDIntegerAn ID for this specific ScrollableMessage to allow cancellation through the `CancelInteraction` RPC.NSmartDeviceLink 6.0
SmartDeviceLink 6.0
*

Response

* Non-default Result Codes: - *

SUCCESS

- *

INVALID_DATA

- *

OUT_OF_MEMORY

- *

CHAR_LIMIT_EXCEEDED

- *

TOO_MANY_PENDING_REQUESTS

- *

APPLICATION_NOT_REGISTERED

- *

GENERIC_ERROR

- *

DISALLOWED

- *

UNSUPPORTED_RESOURCE

- *

REJECTED

- *

ABORTED

+ *

SUCCESS

+ *

INVALID_DATA

+ *

OUT_OF_MEMORY

+ *

CHAR_LIMIT_EXCEEDED

+ *

TOO_MANY_PENDING_REQUESTS

+ *

APPLICATION_NOT_REGISTERED

+ *

GENERIC_ERROR

+ *

DISALLOWED

+ *

UNSUPPORTED_RESOURCE

+ *

REJECTED

+ *

ABORTED

*

* @see com.smartdevicelink.proxy.rpc.SoftButton */ diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SdlMsgVersion.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SdlMsgVersion.java index f67d3caf0..3aa0773cf 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SdlMsgVersion.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SdlMsgVersion.java @@ -42,34 +42,34 @@ import java.util.Hashtable; * Specifies the version number of the SDL V4 interface. This is used by both the application and SDL to declare what interface version each is using. *

Parameter List

* - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * *
NameTypeDescriptionSmartDeviceLink Ver. Available
majorVersionInteger - *
    - *
  • minvalue="1"
    • - *
  • maxvalue="10"
    • - *
- * 		SmartDeviceLink 1.0
minorVersionInteger - *
    - *
  • minvalue="0"
    • - *
  • maxvalue="1000"
    • - *
- * 		SmartDeviceLink 1.0
NameTypeDescriptionSmartDeviceLink Ver. Available
majorVersionInteger + *
    + *
  • minvalue="1"
    • + *
  • maxvalue="10"
    • + *
+ * 		SmartDeviceLink 1.0
minorVersionInteger + *
    + *
  • minvalue="0"
    • + *
  • maxvalue="1000"
    • + *
+ * 		SmartDeviceLink 1.0
* * @since SmartDeviceLink 1.0 diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetAppIcon.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetAppIcon.java index 4b68de127..aad096b14 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetAppIcon.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetAppIcon.java @@ -45,30 +45,30 @@ import java.util.Hashtable; *

Parameter List

* * - * - * - * - * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * + * + * + * * *
Param NameTypeDescription
Param NameTypeDescription Req.NotesVersion Available
SDLFileNameStringFile reference name.NotesVersion Available
SDLFileNameStringFile reference name.YMaxlength=500SmartDeviceLink 2.0
Maxlength=500SmartDeviceLink 2.0
* *

Response

*

Non-default Result Codes:

*

SUCCESS

- *

INVALID_DATA

- *

OUT_OF_MEMORY

+ *

INVALID_DATA

+ *

OUT_OF_MEMORY

*

TOO_MANY_PENDING_REQUESTS

*

APPLICATION_NOT_REGISTERED

*

GENERIC_ERROR

diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetDisplayLayout.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetDisplayLayout.java index f444b9db3..43dbc4f79 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetDisplayLayout.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetDisplayLayout.java @@ -46,39 +46,39 @@ import java.util.Hashtable; * *

Parameter List

* - * - * - * - * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * * - * - * + * + * * - * - * - * - * + * + * + * + * * * - * - * + * + * * *
Param NameTypeDescription
Param NameTypeDescription Req.NotesVersion Available
displayLayoutstringPredefined or dynamically created screen layout.

Currently only predefined screen layouts are defined.

Predefined layouts include: "ONSCREEN_PRESETS" Custom screen containing app-defined onscreen presets. 		NotesVersion Available
displayLayoutstringPredefined or dynamically created screen layout.

Currently only predefined screen layouts are defined.

Predefined layouts include: "ONSCREEN_PRESETS" Custom screen containing app-defined onscreen presets. 		Ymaxlength: 500SmartDeviceLink 2.0
dayColorSchemeTemplateColorSchemeThe color scheme that is used for day.maxlength: 500SmartDeviceLink 2.0
dayColorSchemeTemplateColorSchemeThe color scheme that is used for day.NSmartDeviceLink 5.0
SmartDeviceLink 5.0
nightColorSchemeTemplateColorSchemeThe color scheme that is used for night.
nightColorSchemeTemplateColorSchemeThe color scheme that is used for night.NSmartDeviceLink 5.0
SmartDeviceLink 5.0
*

Response

diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetGlobalProperties.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetGlobalProperties.java index 9941542fa..e05bd7111 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetGlobalProperties.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetGlobalProperties.java @@ -54,78 +54,78 @@ import java.util.List; *

Parameter List

* * - * - * - * - * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * * *
Param NameTypeDescription
Param NameTypeDescription Req.NotesVersion Available
helpPromptTTSChunkThe help prompt. An array of text chunks of type TTSChunk. See {@linkplain TTSChunk}.The array must have at least one item.NotesVersion Available
helpPromptTTSChunkThe help prompt. An array of text chunks of type TTSChunk. See {@linkplain TTSChunk}.The array must have at least one item.NArray must have at least one element.

Only optional it timeoutPrompt has been specified.

minsize:1; maxsize: 100		SmartDeviceLink 1.0
timeoutPromptTTSChunkArray of one or more TTSChunk elements specifying the help prompt used in an interaction started by PTT.Array must have at least one element.

Only optional it timeoutPrompt has been specified.

minsize:1; maxsize: 100		SmartDeviceLink 1.0
timeoutPromptTTSChunkArray of one or more TTSChunk elements specifying the help prompt used in an interaction started by PTT.NArray must have at least one element. Only optional it helpPrompt has been specified

minsize: 1; maxsize: 100

SmartDeviceLink 1.0
vrHelpTitlestringText, which is shown as title of the VR help screen used in an interaction started by PTT.Array must have at least one element. Only optional it helpPrompt has been specified

minsize: 1; maxsize: 100

SmartDeviceLink 1.0
vrHelpTitlestringText, which is shown as title of the VR help screen used in an interaction started by PTT.NIf omitted on supported displays, the default SDL help title will be used.

If omitted and one or more vrHelp items are provided, the request will be rejected.

maxLength: 500		SmartDeviceLink 1.0
vrHelpVrHelpItems listed in the VR help screen used in an interaction started by PTT.If omitted on supported displays, the default SDL help title will be used.

If omitted and one or more vrHelp items are provided, the request will be rejected.

maxLength: 500		SmartDeviceLink 1.0
vrHelpVrHelpItems listed in the VR help screen used in an interaction started by PTT.NIf omitted on supported displays, the default SDL VR help / What Can I Say? screen will be used

If the list of VR Help Items contains non-sequential positions (e.g. [1,2,4]), the RPC will be rejected.

If omitted and a vrHelpTitle is provided, the request will be rejected.

minsize:1; maxsize: 100 		SmartDeviceLink 1.0
menuTitleOptional text to label an app menu button (for certain touchscreen platforms).If omitted on supported displays, the default SDL VR help / What Can I Say? screen will be used

If the list of VR Help Items contains non-sequential positions (e.g. [1,2,4]), the RPC will be rejected.

If omitted and a vrHelpTitle is provided, the request will be rejected.

minsize:1; maxsize: 100 		SmartDeviceLink 1.0
menuTitleOptional text to label an app menu button (for certain touchscreen platforms).Nmaxlength: 500SmartDeviceLink 1.0
menuIcon ImageOptional icon to draw on an app menu button (for certain touchscreen platforms).maxlength: 500SmartDeviceLink 1.0
menuIcon ImageOptional icon to draw on an app menu button (for certain touchscreen platforms).NSmartDeviceLink 1.0
keyboardPropertiesKeyboardPropertiesOn-screen keyboard configuration (if available).SmartDeviceLink 1.0
keyboardPropertiesKeyboardPropertiesOn-screen keyboard configuration (if available).NSmartDeviceLink 1.0
menuLayoutMenuLayoutSets the layout of the main menu screen. If this is sent while a menu is already on-screen, the head unit will change the display to the new layout type.SmartDeviceLink 6.0
SmartDeviceLink 1.0
menuLayoutMenuLayoutSets the layout of the main menu screen. If this is sent while a menu is already on-screen, the head unit will change the display to the new layout type.SmartDeviceLink 6.0
* diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetMediaClockTimer.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetMediaClockTimer.java index 099224638..e0f3d551e 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SetMediaClockTimer.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SetMediaClockTimer.java @@ -52,50 +52,50 @@ import java.util.Hashtable; *

Parameter List

* * - * - * - * - * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * + * + * + * + * * * * @@ -106,7 +106,7 @@ import java.util.Hashtable; * @since SmartDeviceLink 7.1.0 * * - * + * * * * @@ -133,9 +133,9 @@ import java.util.Hashtable; * *

Non-default Result Codes:

* - *

SUCCESS

- *

INVALID_DATA

- *

OUT_OF_MEMORY

+ *

SUCCESS

+ *

INVALID_DATA

+ *

OUT_OF_MEMORY

*

TOO_MANY_PENDING_REQUESTS

*

APPLICATION_NOT_REGISTERED

*

GENERIC_ERROR

diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/Show.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/Show.java index e9bdcd905..ce1dd1bb3 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/Show.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/Show.java @@ -58,129 +58,129 @@ import java.util.List; * *

Parameter List

*
Param NameTypeDescription
Param NameTypeDescription Req.NotesVersion Available
startTimeStartTimeStartTime struct specifying hour, minute, second values to which media clock timer is set.NotesVersion Available
startTimeStartTimeStartTime struct specifying hour, minute, second values to which media clock timer is set.N SmartDeviceLink 1.0
endTimeStartTime EndTime can be provided for "COUNTUP" and "COUNTDOWN"; to be used to calculate any visual progress bar (if not provided, this feature is ignored) + * SmartDeviceLink 1.0
endTimeStartTime EndTime can be provided for "COUNTUP" and "COUNTDOWN"; to be used to calculate any visual progress bar (if not provided, this feature is ignored) * If endTime is greater than startTime for COUNTDOWN or less than startTime for COUNTUP, then the request will return an INVALID_DATA. * endTime will be ignored for "RESUME", and "CLEAR" * endTime can be sent for "PAUSE", in which case it will update the paused endTimeNArray must have at least one element.

Only optional it helpPrompt has been specified

minsize: 1; maxsize: 100		SmartDeviceLink 1.0
updateModeUpdateModeSpecifies how the media clock/timer is to be updated (COUNTUP/COUNTDOWN/PAUSE/RESUME), based at the startTime.Array must have at least one element.

Only optional it helpPrompt has been specified

minsize: 1; maxsize: 100		SmartDeviceLink 1.0
updateModeUpdateModeSpecifies how the media clock/timer is to be updated (COUNTUP/COUNTDOWN/PAUSE/RESUME), based at the startTime.YIf "updateMode" is COUNTUP or COUNTDOWN, this parameter must be provided. Will be ignored for PAUSE,RESUME and CLEARSmartDeviceLink 1.0
audioStreamingIndicatorAudioStreamingIndicatorIf "updateMode" is COUNTUP or COUNTDOWN, this parameter must be provided. Will be ignored for PAUSE,RESUME and CLEARSmartDeviceLink 1.0
audioStreamingIndicatorAudioStreamingIndicatorNSmartDeviceLink 5.0
SmartDeviceLink 5.0
countRateFloatThe value of this parameter is the amount that the media clock timer will advance per 1.0 seconds of real time. Values less than 1.0 will therefore advance the timer slower than real-time, while values greater than 1.0 will advance the timer faster than real-time.e.g. If this parameter is set to `0.5`, the timer will advance one second per two seconds real-time, or at 50% speed. If this parameter is set to `2.0`, the timer will advance two seconds per one second real-time, or at 200% speed.
forwardSeekIndicatorSeekStreamingIndicatorUsed to control the forward seek button to either skip forward a set amount of time or to the next track.
- * - * - * - * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * * *
Param NameTypeDescription
Param NameTypeDescription Req.NotesVersion Available
mainField1StringText to be displayed in a single-line display, or in the upper display line in a two-line display.NotesVersion Available
mainField1StringText to be displayed in a single-line display, or in the upper display line in a two-line display.NIf this parameter is omitted, the text of mainField1 does not change. If this parameter is an empty string, the field will be cleared.

Maxlength = 500

SmartDeviceLink 1.0
mainField2StringText to be displayed on the second display line of a two-line display.If this parameter is omitted, the text of mainField1 does not change. If this parameter is an empty string, the field will be cleared.

Maxlength = 500

SmartDeviceLink 1.0
mainField2StringText to be displayed on the second display line of a two-line display.N

If this parameter is omitted, the text of mainField2 does not change.

If this parameter is an empty string, the field will be cleared.

If provided and the display is a single-line display, the parameter is ignored.

Maxlength = 500		SmartDeviceLink 1.0
mainField3StringText to be displayed on the first display line of the second page.

If this parameter is omitted, the text of mainField2 does not change.

If this parameter is an empty string, the field will be cleared.

If provided and the display is a single-line display, the parameter is ignored.

Maxlength = 500		SmartDeviceLink 1.0
mainField3StringText to be displayed on the first display line of the second page.N

If this parameter is omitted, the text of mainField3 does not change.

If this parameter is an empty string, the field will be cleared.

If provided and the display is a single-line display, the parameter is ignored.

Maxlength = 500		SmartDeviceLink 2.0
mainField4StringText to be displayed on the second display line of the second page.

If this parameter is omitted, the text of mainField3 does not change.

If this parameter is an empty string, the field will be cleared.

If provided and the display is a single-line display, the parameter is ignored.

Maxlength = 500		SmartDeviceLink 2.0
mainField4StringText to be displayed on the second display line of the second page.N

If this parameter is omitted, the text of mainField4 does not change.

If this parameter is an empty string, the field will be cleared.

If provided and the display is a single-line display, the parameter is ignored.

Maxlength = 500		SmartDeviceLink 2.0
alignmentTextAlignmentSpecifies how mainField1 and mainField2 text should be aligned on display.

If this parameter is omitted, the text of mainField4 does not change.

If this parameter is an empty string, the field will be cleared.

If provided and the display is a single-line display, the parameter is ignored.

Maxlength = 500		SmartDeviceLink 2.0
alignmentTextAlignmentSpecifies how mainField1 and mainField2 text should be aligned on display.N

Applies only to mainField1 and mainField2 provided on this call, not to what is already showing in display.

If this parameter is omitted, text in both mainField1 and mainField2 will be centered.

Has no effect with navigation display		SmartDeviceLink 1.0
statusBarStringThe text is placed in the status bar area.

Applies only to mainField1 and mainField2 provided on this call, not to what is already showing in display.

If this parameter is omitted, text in both mainField1 and mainField2 will be centered.

Has no effect with navigation display		SmartDeviceLink 1.0
statusBarStringThe text is placed in the status bar area.N

Note: The status bar only exists on navigation displays

If this parameter is omitted, the status bar text will remain unchanged.

If this parameter is an empty string, the field will be cleared.

If provided and the display has no status bar, this parameter is ignored.

Maxlength = 500		SmartDeviceLink 1.0
mediaClockStringText value for MediaClock field. Has to be properly formatted by Mobile App according to the module's capabilities. If this text is set, any automatic media clock updates previously set with SetMediaClockTimer will be stopped.

Note: The status bar only exists on navigation displays

If this parameter is omitted, the status bar text will remain unchanged.

If this parameter is an empty string, the field will be cleared.

If provided and the display has no status bar, this parameter is ignored.

Maxlength = 500		SmartDeviceLink 1.0
mediaClockStringText value for MediaClock field. Has to be properly formatted by Mobile App according to the module's capabilities. If this text is set, any automatic media clock updates previously set with SetMediaClockTimer will be stopped.N{"string_min_length": 0, "string_max_length": 500} - * @since SmartDeviceLink 1.0.0 - * @property-deprecated in SmartDeviceLink 7.1.0 - *
mediaTrackStringArray of one or more TTSChunk elements specifying the help prompt used in an interaction started by PTT.{"string_min_length": 0, "string_max_length": 500} + * @since SmartDeviceLink 1.0.0 + * @property-deprecated in SmartDeviceLink 7.1.0 + *
mediaTrackStringArray of one or more TTSChunk elements specifying the help prompt used in an interaction started by PTT.N

If parameter is omitted, the track field remains unchanged.

If an empty string is provided, the field will be cleared.

This field is only valid for media applications on navigation displays.

Maxlength = 500		SmartDeviceLink 1.0
graphicImageImage to be shown on supported displays.

If parameter is omitted, the track field remains unchanged.

If an empty string is provided, the field will be cleared.

This field is only valid for media applications on navigation displays.

Maxlength = 500		SmartDeviceLink 1.0
graphicImageImage to be shown on supported displays.NIf omitted on supported displays, the displayed graphic shall not change.SmartDeviceLink 2.0
secondaryGraphicImage

Image struct determining whether static or dynamic secondary image to display in app.

If omitted on supported displays, the displayed secondary graphic shall not change.		If omitted on supported displays, the displayed graphic shall not change.SmartDeviceLink 2.0
secondaryGraphicImage

Image struct determining whether static or dynamic secondary image to display in app.

If omitted on supported displays, the displayed secondary graphic shall not change.		N SmartDeviceLink 2.3.2
softButtonsSoftButtonSoft buttons as defined by the App SmartDeviceLink 2.3.2
softButtonsSoftButtonSoft buttons as defined by the AppN

If omitted on supported displays, the currently displayed SoftButton values will not change.

Array Minsize: 0; Array Maxsize: 8		SmartDeviceLink 2.0
customPresetsStringCustom presets as defined by the App.

If omitted on supported displays, the currently displayed SoftButton values will not change.

Array Minsize: 0; Array Maxsize: 8		SmartDeviceLink 2.0
customPresetsStringCustom presets as defined by the App.N

If omitted on supported displays, the presets will be shown as not defined.

Minsize: 0; Maxsize: 6		SmartDeviceLink 2.0
templateTitleStringThe title of the new template that will be displayed.

How this will be displayed is dependent on the OEM design and implementation of the template..

Minsize: 0; Maxsize: 100		NSmartDeviceLink 6.0.0

If omitted on supported displays, the presets will be shown as not defined.

Minsize: 0; Maxsize: 6		SmartDeviceLink 2.0
templateTitleStringThe title of the new template that will be displayed.

How this will be displayed is dependent on the OEM design and implementation of the template..

Minsize: 0; Maxsize: 100		NSmartDeviceLink 6.0.0
*

Response

* *

Non-default Result Codes:

- *

SUCCESS

- *

INVALID_DATA

- *

OUT_OF_MEMORY

+ *

SUCCESS

+ *

INVALID_DATA

+ *

OUT_OF_MEMORY

*

TOO_MANY_PENDING_REQUESTS

*

APPLICATION_NOT_REGISTERED

*

GENERIC_ERROR

diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SingleTireStatus.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SingleTireStatus.java index d68abf738..f948c471a 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SingleTireStatus.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SingleTireStatus.java @@ -43,34 +43,34 @@ import java.util.Hashtable; * Tire pressure status of a single tire. *

Parameter List

* - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * *
NameTypeDescriptionSmartDeviceLink Ver. Available
statusComponentVolumeStatusDescribes the volume status of a single tire - * See {@linkplain ComponentVolumeStatus} - * SmartDeviceLink 2.0
tpmsTPMSThe status of TPMS according to the particular tire. - * See {@linkplain com.smartdevicelink.proxy.rpc.enums.TPMS} - * SmartDeviceLink 5.0
pressureFloatThe pressure value of the particular tire in kilo pascal.SmartDeviceLink 5.0
NameTypeDescriptionSmartDeviceLink Ver. Available
statusComponentVolumeStatusDescribes the volume status of a single tire + * See {@linkplain ComponentVolumeStatus} + * SmartDeviceLink 2.0
tpmsTPMSThe status of TPMS according to the particular tire. + * See {@linkplain com.smartdevicelink.proxy.rpc.enums.TPMS} + * SmartDeviceLink 5.0
pressureFloatThe pressure value of the particular tire in kilo pascal.SmartDeviceLink 5.0
* * @since SmartDeviceLink 2.0 diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/Slider.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/Slider.java index fae2a8165..3eab5d9bb 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/Slider.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/Slider.java @@ -50,78 +50,78 @@ import java.util.List; * *

Parameter List

* - * - * - * - * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * + * + * + * * - * - * - * - * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * + * + * + * * - * - * - * - * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * + * + * + * *
Param NameTypeDescription
Param NameTypeDescription Req.NotesVersion Available
numTicksIntegerNumber of selectable items on a horizontal axis.NotesVersion Available
numTicksIntegerNumber of selectable items on a horizontal axis.YMinvalue=2; Maxvalue=26SmartDeviceLink 2.0
Minvalue=2; Maxvalue=26SmartDeviceLink 2.0
positionIntegerInitial position of slider control (cannot exceed numTicks),
positionIntegerInitial position of slider control (cannot exceed numTicks),YMinvalue=1; Maxvalue=26SmartDeviceLink 2.0
sliderHeaderStringText header to displayMinvalue=1; Maxvalue=26SmartDeviceLink 2.0
sliderHeaderStringText header to displayNMaxlength=500SmartDeviceLink 2.0
sliderFooterInteger

Text footer to display (meant to display min/max threshold descriptors).

For a static text footer, only one footer string shall be provided in the array. For a dynamic text footer, the number of footer text string in the array must match the numTicks value.For a dynamic text footer, text array string should correlate with potential slider position index.If omitted on supported displays, no footer text shall be displayed.		Maxlength=500SmartDeviceLink 2.0
sliderFooterInteger

Text footer to display (meant to display min/max threshold descriptors).

For a static text footer, only one footer string shall be provided in the array. For a dynamic text footer, the number of footer text string in the array must match the numTicks value.For a dynamic text footer, text array string should correlate with potential slider position index.If omitted on supported displays, no footer text shall be displayed.		NMaxlength=500; Minvalue=1; Maxvalue=26SmartDeviceLink 2.0
Maxlength=500; Minvalue=1; Maxvalue=26SmartDeviceLink 2.0
timeoutStringApp defined timeout. Indicates how long of a timeout from the last action (i.e. sliding control resets timeout). If omitted, the value is set to 10000.
timeoutStringApp defined timeout. Indicates how long of a timeout from the last action (i.e. sliding control resets timeout). If omitted, the value is set to 10000.NMinvalue=0; Maxvalue=65535; Defvalue= 10000SmartDeviceLink 2.0
cancelIDIntegerAn ID for this specific slider to allow cancellation through the `CancelInteraction` RPC.Minvalue=0; Maxvalue=65535; Defvalue= 10000SmartDeviceLink 2.0
cancelIDIntegerAn ID for this specific slider to allow cancellation through the `CancelInteraction` RPC.NSmartDeviceLink 6.0
SmartDeviceLink 6.0
*

Response

* *

Non-default Result Codes:

- *

SAVED

- *

INVALID_DATA

- *

OUT_OF_MEMORY

- *

TOO_MANY_PENDING_REQUESTS

- *

APPLICATION_NOT_REGISTERED

- *

GENERIC_ERROR

- *

DISALLOWED

- *

UNSUPPORTED_RESOURCE

- *

REJECTED

- *

ABORTED

+ *

SAVED

+ *

INVALID_DATA

+ *

OUT_OF_MEMORY

+ *

TOO_MANY_PENDING_REQUESTS

+ *

APPLICATION_NOT_REGISTERED

+ *

GENERIC_ERROR

+ *

DISALLOWED

+ *

UNSUPPORTED_RESOURCE

+ *

REJECTED

+ *

ABORTED

* * @since SmartDeviceLink 2.0 */ diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SoftButton.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SoftButton.java index 873522c69..e537d2fc8 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SoftButton.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SoftButton.java @@ -44,62 +44,62 @@ import java.util.Hashtable; * *

Parameter List

* - * - * - * - * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * + * + * * *
NameTypeDescription
NameTypeDescriptionReg.NotesVersion
typeSoftButtonTypeDescribes, whether it is text, highlighted text, icon, or dynamic image. Version
typeSoftButtonTypeDescribes, whether it is text, highlighted text, icon, or dynamic image. SmartDeviceLink 2.0
textStringOptional text to display (if defined as TEXT or BOTH)SmartDeviceLink 2.0
textStringOptional text to display (if defined as TEXT or BOTH)NMin: 0; Maxlength: 500SmartDeviceLink 2.0
imageImageOptional image struct for SoftButton (if defined as IMAGE or BOTH).SmartDeviceLink 2.0
imageImageOptional image struct for SoftButton (if defined as IMAGE or BOTH).SmartDeviceLink 2.0
isHighlightedBooleanTrue, if highlighted False, if not highlightedSmartDeviceLink 2.0
isHighlightedBooleanTrue, if highlighted False, if not highlightedNSmartDeviceLink 2.0
softButtonIDIntegerValue which is returned via OnButtonPress / OnButtonEventSmartDeviceLink 2.0
softButtonIDIntegerValue which is returned via OnButtonPress / OnButtonEventMin: 0; Max: 65535SmartDeviceLink 2.0
systemActionSystemActionParameter indicating whether selecting a SoftButton shall call a specific system action. This is intended to allow Notifications to bring the callee into full / focus; or in the case of persistent overlays, the overlay can persist when a SoftButton is pressed.SmartDeviceLink 2.0
systemActionSystemActionParameter indicating whether selecting a SoftButton shall call a specific system action. This is intended to allow Notifications to bring the callee into full / focus; or in the case of persistent overlays, the overlay can persist when a SoftButton is pressed.Ndefvalue: DEFAULT_ACTIONSmartDeviceLink 2.0
SmartDeviceLink 2.0
*/ diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SoftButtonCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SoftButtonCapabilities.java index c02ba15ed..ca5c0e6f0 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SoftButtonCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SoftButtonCapabilities.java @@ -42,43 +42,43 @@ import java.util.Hashtable; *

Contains information about a SoftButton's capabilities.

*

Parameter List

* - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * *
NameTypeDescriptionSmartDeviceLink Ver. Available
shortPressAvailableBooleanThe button supports a short press. - * Whenever the button is pressed short, onButtonPressed( SHORT) will be invoked. - * SmartDeviceLink 2.0
longPressAvailableBooleanThe button supports a LONG press. - * Whenever the button is pressed long, onButtonPressed( LONG) will be invoked. - * SmartDeviceLink 2.0
upDownAvailableBooleanThe button supports "button down" and "button up". Whenever the button is pressed, onButtonEvent( DOWN) will be invoked. - * Whenever the button is released, onButtonEvent( UP) will be invoked. * - * SmartDeviceLink 2.0
imageSupportedBooleanThe button supports referencing a static or dynamic image. - * SmartDeviceLink 2.0
NameTypeDescriptionSmartDeviceLink Ver. Available
shortPressAvailableBooleanThe button supports a short press. + * Whenever the button is pressed short, onButtonPressed( SHORT) will be invoked. + * SmartDeviceLink 2.0
longPressAvailableBooleanThe button supports a LONG press. + * Whenever the button is pressed long, onButtonPressed( LONG) will be invoked. + * SmartDeviceLink 2.0
upDownAvailableBooleanThe button supports "button down" and "button up". Whenever the button is pressed, onButtonEvent( DOWN) will be invoked. + * Whenever the button is released, onButtonEvent( UP) will be invoked. * + * SmartDeviceLink 2.0
imageSupportedBooleanThe button supports referencing a static or dynamic image. + * SmartDeviceLink 2.0
* * @since SmartDeviceLink 2.0 diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/Speak.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/Speak.java index 651cdb8bc..6cb97a34b 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/Speak.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/Speak.java @@ -103,37 +103,37 @@ import java.util.List; * *

Parameter List

* - * - * - * - * + * + * + * + * * * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * *
NameTypeDescription
NameTypeDescriptionReg.Notes Ver. Available
ttsChunksStringAn array of 1-100 TTSChunk structs which, taken together, specify the phrase to be spoken.Y

The array must have 1-100 elements.

The total length of the phrase composed from the ttsChunks provided must be less than 500 characters or the request will be rejected.

Each chunk can be no more than 500 characters.		SmartDeviceLink 1.0
Ver. Available
ttsChunksStringAn array of 1-100 TTSChunk structs which, taken together, specify the phrase to be spoken.Y

The array must have 1-100 elements.

The total length of the phrase composed from the ttsChunks provided must be less than 500 characters or the request will be rejected.

Each chunk can be no more than 500 characters.		SmartDeviceLink 1.0
*

Response

*

This Response notifies the application of the completion, interruption, or failure of a Speak Request.

* *

Non-default Result Codes:

* - *

SUCCESS

- *

INVALID_DATA

- *

OUT_OF_MEMORY

- *

APPLICATION_NOT_REGISTERED

- *

TOO_MANY_PENDING_REQUESTS

- *

GENERIC_ERROR

- *

REJECTED

- *

DISALLOWED

- *

ABORTED

+ *

SUCCESS

+ *

INVALID_DATA

+ *

OUT_OF_MEMORY

+ *

APPLICATION_NOT_REGISTERED

+ *

TOO_MANY_PENDING_REQUESTS

+ *

GENERIC_ERROR

+ *

REJECTED

+ *

DISALLOWED

+ *

ABORTED

* *

Additional Notes:

    Total character limit depends on platform. Chunks are limited to 500 characters; however you can have multiple TTS chunks. On Gen 1.1 there is a total character limit of 500 characters across all chunks. This could vary according to the VCA. * diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/StartTime.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/StartTime.java index e2cdd6be9..ae31614f9 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/StartTime.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/StartTime.java @@ -41,32 +41,32 @@ import java.util.Hashtable; * Describes the hour, minute and second values used to set the media clock. *

    Parameter List

    * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * * - * - * - * - * - * + * + * + * + * + * *
    NameTypeDescriptionSmartDeviceLink Ver. Available
    hoursIntegerThe hour. Minvalue="0", maxvalue="59" - *

    Note:

    Some display types only support a max value of 19. If out of range, it will be rejected. - *     		SmartDeviceLink 1.0
    minutesIntegerThe minute. Minvalue="0", maxvalue="59".SmartDeviceLink 1.0
    NameTypeDescriptionSmartDeviceLink Ver. Available
    hoursIntegerThe hour. Minvalue="0", maxvalue="59" + *

    Note:

    Some display types only support a max value of 19. If out of range, it will be rejected. + *     		SmartDeviceLink 1.0
    minutesIntegerThe minute. Minvalue="0", maxvalue="59".SmartDeviceLink 1.0
    secondsIntegerThe second. Minvalue="0", maxvalue="59".SmartDeviceLink 1.0
    secondsIntegerThe second. Minvalue="0", maxvalue="59".SmartDeviceLink 1.0
    * * @since SmartDeviceLink 1.0 diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeButton.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeButton.java index 2c99a035a..306b07159 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeButton.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeButton.java @@ -87,22 +87,22 @@ import java.util.Hashtable; * *

    Parameter List

    * - * - * - * - * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * + * + * *
    NameTypeDescription
    NameTypeDescriptionReg.NotesVersion
    buttonNameButtonNameName of the button to subscribe.Version
    buttonNameButtonNameName of the button to subscribe.YSmartDeviceLink 1.0
    SmartDeviceLink 1.0
    * * @see UnsubscribeButton diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeVehicleData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeVehicleData.java index a779c7288..1b7b0fdc3 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeVehicleData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SubscribeVehicleData.java @@ -49,247 +49,247 @@ import java.util.Hashtable; * *

    Parameter List

    * - * - * - * - * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * * - * - * - * - * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * * * * @@ -304,13 +304,13 @@ import java.util.Hashtable; * * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * * * @@ -321,16 +321,16 @@ import java.util.Hashtable; * @since SmartDeviceLink 7.1.0 * * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * *
    NameTypeDescription
    NameTypeDescriptionReg.NotesSmartDeviceLink Version
    gpsBooleanGPS data. See {@linkplain GPSData}for detailsSmartDeviceLink Version
    gpsBooleanGPS data. See {@linkplain GPSData}for detailsNSubscribableSmartDeviceLink 2.0
    speedBooleanThe vehicle speed in kilometers per hourSmartDeviceLink 2.0
    speedBooleanThe vehicle speed in kilometers per hourNSubscribableSmartDeviceLink 2.0
    rpmBooleanThe number of revolutions per minute of the engineSmartDeviceLink 2.0
    rpmBooleanThe number of revolutions per minute of the engineNSubscribableSmartDeviceLink 2.0
    fuelLevelBooleanThe fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec7.0, please see fuelRange.SmartDeviceLink 2.0
    fuelLevelBooleanThe fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec7.0, please see fuelRange.NSubscribableSmartDeviceLink 7.0.0
    fuelLevel_StateBooleanThe fuel level state. This parameter is deprecated starting RPC Spec 7.0, please see fuelRange.SmartDeviceLink 7.0.0
    fuelLevel_StateBooleanThe fuel level state. This parameter is deprecated starting RPC Spec 7.0, please see fuelRange.NSubscribableSmartDeviceLink 7.0.0
    fuelRangeBooleanThe fuel type, estimated range in KM, fuel level/capacity and fuel level state for the vehicle. See struct FuelRange for details.SmartDeviceLink 7.0.0
    fuelRangeBooleanThe fuel type, estimated range in KM, fuel level/capacity and fuel level state for the vehicle. See struct FuelRange for details.NSubscribableSmartDeviceLink 5.0.0
    instantFuelConsumptionBooleanThe instantaneous fuel consumption in micro litresSmartDeviceLink 5.0.0
    instantFuelConsumptionBooleanThe instantaneous fuel consumption in micro litresNSubscribableSmartDeviceLink 2.0
    externalTemperatureBooleanThe external temperature in degrees celsius. This parameter is deprecated starting RPCSpec 7.1.0, please see climateData.SmartDeviceLink 2.0
    externalTemperatureBooleanThe external temperature in degrees celsius. This parameter is deprecated starting RPCSpec 7.1.0, please see climateData.NSubscribable - * @since SmartDeviceLink 2.0.0 - * @property-deprecated in SmartDeviceLink 7.1.0 - *
    gearStatusBooleanSee GearStatusNSmartDeviceLink 7.0.0
    prndlBooleanSee PRNDL. This parameter is deprecated and it is now covered in `gearStatus`NSmartDeviceLink 7.0.0 + * @since SmartDeviceLink 2.0.0 + * @property-deprecated in SmartDeviceLink 7.1.0 + *
    gearStatusBooleanSee GearStatusNSmartDeviceLink 7.0.0
    prndlBooleanSee PRNDL. This parameter is deprecated and it is now covered in `gearStatus`NSmartDeviceLink 7.0.0
    tirePressureBooleanTire pressure status
    tirePressureBooleanTire pressure statusNSubscribableSmartDeviceLink 2.0
    odometerBooleanOdometer in kmSmartDeviceLink 2.0
    odometerBooleanOdometer in kmNMax Length: 500SmartDeviceLink 2.0
    beltStatusBooleanThe status of the seat beltsSmartDeviceLink 2.0
    beltStatusBooleanThe status of the seat beltsNSubscribableSmartDeviceLink 2.0
    bodyInformationBooleanThe body information including ignition status and internal tempNSubscribableSmartDeviceLink 2.0
    deviceStatusBooleanThe device status including signal and battery strengthNSubscribableSmartDeviceLink 2.0
    bodyInformationBooleanThe body information including ignition status and internal tempSmartDeviceLink 2.0
    driverBrakingBooleanThe status of the brake pedalNSubscribableSmartDeviceLink 2.0
    deviceStatusBooleanThe device status including signal and battery strengthSmartDeviceLink 2.0
    wiperStatusBooleanThe status of the wipersNSubscribableSmartDeviceLink 2.0
    driverBrakingBooleanThe status of the brake pedalSmartDeviceLink 2.0
    headLampStatusBooleanStatus of the head lampsNSubscribableSmartDeviceLink 2.0
    wiperStatusBooleanThe status of the wipersSmartDeviceLink 2.0
    engineTorqueBooleanTorque value for engine (in Nm) on non-diesel variantsNSubscribableSmartDeviceLink 2.0
    headLampStatusBooleanStatus of the head lampsSmartDeviceLink 2.0
    engineOilLifeBooleanThe estimated percentage of remaining oil life of the engineNSubscribableSmartDeviceLink 2.0
    engineTorqueBooleanTorque value for engine (in Nm) on non-diesel variantsSmartDeviceLink 5.0
    accPedalPositionBooleanAccelerator pedal position (percentage depressed)NSubscribableSmartDeviceLink 2.0
    engineOilLifeBooleanThe estimated percentage of remaining oil life of the engineSmartDeviceLink 2.0
    steeringWheelAngleBooleanCurrent angle of the steering wheel (in deg)NSubscribableSmartDeviceLink 5.0
    accPedalPositionBooleanAccelerator pedal position (percentage depressed)SmartDeviceLink 2.0
    eCallInfoBooleanEmergency Call notification and confirmation data.NSubscribableSmartDeviceLink 2.0
    steeringWheelAngleBooleanCurrent angle of the steering wheel (in deg)SmartDeviceLink 2.0
    airbagStatusBooleanThe status of the air bags.NSubscribableSmartDeviceLink 2.0
    eCallInfoBooleanEmergency Call notification and confirmation data.SmartDeviceLink 2.0
    emergencyEventBooleanInformation related to an emergency event (and if it occurred).NSubscribableSmartDeviceLink 2.0
    airbagStatusBooleanThe status of the air bags.SmartDeviceLink 2.0
    clusterModeStatusBooleanThe status modes of the instrument panel cluster.NSubscribableSmartDeviceLink 2.0
    emergencyEventBooleanInformation related to an emergency event (and if it occurred).SmartDeviceLink 2.0
    myKeyBooleanInformation related to the MyKey feature.NSubscribableSmartDeviceLink 2.0
    clusterModeStatusBooleanThe status modes of the instrument panel cluster.SmartDeviceLink 2.0
    turnSignalBoolean@see TurnSignalNSubscribableSmartDeviceLink 2.0
    myKeyBooleanInformation related to the MyKey feature.SmartDeviceLink 5.0
    cloudAppVehicleIDBooleanID for the vehicle when connecting to cloud applicationsNSubscribableSmartDeviceLink 2.0
    turnSignalBoolean@see TurnSignalNSubscribableSmartDeviceLink 5.0
    cloudAppVehicleIDBooleanID for the vehicle when connecting to cloud applicationsNSubscribableSmartDeviceLink 5.1
    SmartDeviceLink 5.1
    handsOffSteeringBooleanNSmartDeviceLink 7.0.0
    stabilityControlsStatusBooleanSee StabilityControlsStatusNSmartDeviceLink 7.0.0
    stabilityControlsStatusBooleanSee StabilityControlsStatusNSmartDeviceLink 7.0.0
    climateDataBoolean
    seatOccupancyBooleanSee SeatOccupancyN - * @since SmartDeviceLink 7.1.0 - *
    seatOccupancyBooleanSee SeatOccupancyN + * @since SmartDeviceLink 7.1.0 + *
    * *

    Response

    @@ -338,13 +338,13 @@ import java.util.Hashtable; *

    SUCCESS

    *

    WARNINGS

    *

    INVALID_DATA

    - *

    OUT_OF_MEMORY

    - *

    TOO_MANY_PENDING_REQUESTS

    - *

    APPLICATION_NOT_REGISTERED

    - *

    GENERIC_ERROR

    - *

    IGNORED

    - *

    DISALLOWED

    - *

    USER_DISALLOWED

    + *

    OUT_OF_MEMORY

    + *

    TOO_MANY_PENDING_REQUESTS

    + *

    APPLICATION_NOT_REGISTERED

    + *

    GENERIC_ERROR

    + *

    IGNORED

    + *

    DISALLOWED

    + *

    USER_DISALLOWED

    * * @see UnsubscribeVehicleData * @see GetVehicleData diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/SystemRequest.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/SystemRequest.java index 8386c2c5a..b8137c7c0 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/SystemRequest.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/SystemRequest.java @@ -45,38 +45,38 @@ import java.util.List; * *

    Parameter List

    * - * - * - * - * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * + * + * *
    NameTypeDescription
    NameTypeDescriptionReg.NotesVersion
    requestTypeRequestTypeThe type of system request. Note that Proprietary requests should forward the binary data to the known proprietary module on the system.Version
    requestTypeRequestTypeThe type of system request. Note that Proprietary requests should forward the binary data to the known proprietary module on the system.YSmartDeviceLink 3.0
    requestSubTypeStringThis parameter is filled for supporting OEM proprietary data exchanges.SmartDeviceLink 3.0
    requestSubTypeStringThis parameter is filled for supporting OEM proprietary data exchanges.NMax Length: 255SmartDeviceLink 5.0
    fileNameStringFilename of HTTP data to store in predefined system staging area. Mandatory if requestType is HTTP. PROPRIETARY requestType should ignore this parameter. SmartDeviceLink 5.0
    fileNameStringFilename of HTTP data to store in predefined system staging area. Mandatory if requestType is HTTP. PROPRIETARY requestType should ignore this parameter. NMax Length: 255SmartDeviceLink 3.0
    SmartDeviceLink 3.0
    * * @since SmartDeviceLink 3.0 diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/TTSChunk.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/TTSChunk.java index 1333fa7bf..702b4ca61 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/TTSChunk.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/TTSChunk.java @@ -49,24 +49,24 @@ import java.util.Hashtable; *

    For more information about phonemes, see http://en.wikipedia.org/wiki/Phoneme

    . *

    Parameter List

    * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * *
    NameTypeDescriptionSmartDeviceLink Ver. Available
    textStringText to be spoken, or a phoneme specification, or the name of a pre-recorded sound. The contents of this field are indicated by the "type" field.SmartDeviceLink 1.0
    typeSpeechCapabilitiesIndicates the type of information in the "text" field (e.g. phrase to be spoken, phoneme specification, name of pre-recorded sound). SmartDeviceLink 1.0
    NameTypeDescriptionSmartDeviceLink Ver. Available
    textStringText to be spoken, or a phoneme specification, or the name of a pre-recorded sound. The contents of this field are indicated by the "type" field.SmartDeviceLink 1.0
    typeSpeechCapabilitiesIndicates the type of information in the "text" field (e.g. phrase to be spoken, phoneme specification, name of pre-recorded sound). SmartDeviceLink 1.0
    * * @since SmartDeviceLink 1.0 diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/TemplateColorScheme.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/TemplateColorScheme.java index e8b3c9acb..3168972a4 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/TemplateColorScheme.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/TemplateColorScheme.java @@ -39,34 +39,34 @@ import java.util.Hashtable; * A color scheme for all display layout templates. *

    Parameter List

    * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * *
    NameTypeDescriptionReg.Version Available
    primaryColorRGBColorThe primary "accent" colorNSmartDeviceLink 5.0
    secondaryColorRGBColorThe secondary "accent" colorNSmartDeviceLink 5.0
    backgroundColorRGBColorThe color of the backgroundNSmartDeviceLink 5.0
    NameTypeDescriptionReg.Version Available
    primaryColorRGBColorThe primary "accent" colorNSmartDeviceLink 5.0
    secondaryColorRGBColorThe secondary "accent" colorNSmartDeviceLink 5.0
    backgroundColorRGBColorThe color of the backgroundNSmartDeviceLink 5.0
    * * @since SmartDeviceLink 5.0 diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/TextField.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/TextField.java index 4b0b8a94e..e89069e67 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/TextField.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/TextField.java @@ -43,46 +43,46 @@ import java.util.Hashtable; * Struct defining the characteristics of a displayed field on the HMI. *

    Parameter List

    * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * *
    NameTypeDescriptionSmartDeviceLink Ver. Available
    nameTextFieldNameEnumeration identifying the field. SmartDeviceLink 1.0
    characterSetCharacterSetThe set of characters that are supported by this text field. All text is sent in UTF-8 format, but not all systems may support all of the characters expressed by UTF-8. All systems will support at least ASCII, but they may support more, either the LATIN-1 character set, or the full UTF-8 character set. SmartDeviceLink 1.0
    widthIntegerThe number of characters in one row of this field. - *
      - *
    • Minvalue="1"
      • - *
    • maxvalue="500"
      • - *
    - *     		SmartDeviceLink 1.0
    rowsIntegerThe number of rows for this text field. - *
      - *
    • Minvalue="1"
      • - *
    • maxvalue="3"
      • - *
    - *     		SmartDeviceLink 1.0
    NameTypeDescriptionSmartDeviceLink Ver. Available
    nameTextFieldNameEnumeration identifying the field. SmartDeviceLink 1.0
    characterSetCharacterSetThe set of characters that are supported by this text field. All text is sent in UTF-8 format, but not all systems may support all of the characters expressed by UTF-8. All systems will support at least ASCII, but they may support more, either the LATIN-1 character set, or the full UTF-8 character set. SmartDeviceLink 1.0
    widthIntegerThe number of characters in one row of this field. + *
      + *
    • Minvalue="1"
      • + *
    • maxvalue="500"
      • + *
    + *     		SmartDeviceLink 1.0
    rowsIntegerThe number of rows for this text field. + *
      + *
    • Minvalue="1"
      • + *
    • maxvalue="3"
      • + *
    + *     		SmartDeviceLink 1.0
    * * @see TextFieldName diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchCoord.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchCoord.java index 979adc303..8cd212326 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchCoord.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchCoord.java @@ -44,30 +44,30 @@ import java.util.Hashtable; * *

    Parameter List

    * - * - * - * - * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * + * + * *
    NameTypeDescription
    NameTypeDescriptionReg.Notes Version
    xIntegerThe x coordinate of the touch. Version
    xIntegerThe x coordinate of the touch.Yminvalue = 0; maxvalue = 10000SmartDeviceLink 3.0
    yIntegerThe y coordinate of the touch.SmartDeviceLink 3.0
    yIntegerThe y coordinate of the touch.Yminvalue = 0; maxvalue = 10000SmartDeviceLink 3.0
    SmartDeviceLink 3.0
    * * @see SoftButtonCapabilities diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchEvent.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchEvent.java index cfa91a20b..ad94a26d2 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchEvent.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchEvent.java @@ -45,40 +45,40 @@ import java.util.List; *

    Parameter List

    * * - * - * - * - * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + *

    If there is only a single timestamp in this array,

    it is the same for every coordinate in the coordinates array. * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * + * + * *
    NameTypeDescription
    NameTypeDescriptionReg.NotesVersion
    idInteger A touch's unique identifier. The application can track the current touch events by id. If a touch event has type begin, the id should be added to the set of touches. If a touch event has type end, the id should be removed from the set of touches.Version
    idInteger A touch's unique identifier. The application can track the current touch events by id. If a touch event has type begin, the id should be added to the set of touches. If a touch event has type end, the id should be removed from the set of touches.NMin Value: 0; Max Value: 9SmartDeviceLink 3.0
    tsFloatThe time that the touch was recorded.

    This number can the time since the beginning of the session or something else as long as the units are in milliseconds.

    + *     		SmartDeviceLink 3.0
    tsFloatThe time that the touch was recorded.

    This number can the time since the beginning of the session or something else as long as the units are in milliseconds.

    *

    The timestamp is used to determined the rate of change of position of a touch.

    The application also uses the time to verify whether two touches,with different ids, are part of a single action by the user.

    - *

    If there is only a single timestamp in this array,

    it is the same for every coordinate in the coordinates array.    		Yminvalue="0" maxvalue="5000000000" minsize="1" maxsize="1000"SmartDeviceLink 3.0
    cIntegerThe coordinates of the screen area where the touch event occurred.SmartDeviceLink 3.0
    cIntegerThe coordinates of the screen area where the touch event occurred.YSmartDeviceLink 3.0
    SmartDeviceLink 3.0
    *

    * @since SmartDeviceLink 3.0 diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchEventCapabilities.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchEventCapabilities.java index c2e5ec216..736e5d7cf 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchEventCapabilities.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/TouchEventCapabilities.java @@ -42,38 +42,38 @@ import java.util.Hashtable; * *

    Parameter List

    * - * - * - * - * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * + * + * * - * - * - * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * + * + * *
    NameTypeDescription
    NameTypeDescriptionReg.NotesSmartDeviceLink Version
    pressAvailableBooleanSmartDeviceLink Version
    pressAvailableBooleanYSmartDeviceLink 3.0
    SmartDeviceLink 3.0
    multiTouchAvailableBooleanmultiTouchAvailableBooleanYSmartDeviceLink 3.0
    doublePressAvailableBooleanSmartDeviceLink 3.0
    doublePressAvailableBooleanYSmartDeviceLink 3.0
    SmartDeviceLink 3.0
    */ public class TouchEventCapabilities extends RPCStruct { diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeButton.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeButton.java index e689689ca..d139769ac 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeButton.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeButton.java @@ -50,22 +50,22 @@ import java.util.Hashtable; * *

    Parameter List

    * - * - * - * - * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * + * + * + * *
    Param NameTypeDescription
    Param NameTypeDescription Req.NotesVersion Available
    buttonNameButtonNameName of the button to unsubscribe.NotesVersion Available
    buttonNameButtonNameName of the button to unsubscribe.YSmartDeviceLink 1.0
    SmartDeviceLink 1.0
    * *

    Response

    diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleData.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleData.java index 3f3dff1bf..3153e35eb 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleData.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/UnsubscribeVehicleData.java @@ -44,239 +44,239 @@ import java.util.Hashtable; * *

    Parameter List

    * - * - * - * - * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * + * + * + * + * + * + * * * - * - * - * - * - * - * - * - * - * - * + * + * * * * @@ -291,13 +291,13 @@ import java.util.Hashtable; * * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * * * @@ -308,30 +308,30 @@ import java.util.Hashtable; * @since SmartDeviceLink 7.1.0 * * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * * * *
    NameTypeDescription
    NameTypeDescriptionReg.NotesVersion
    gpsBooleanGPS data. See {@linkplain com.smartdevicelink.proxy.rpc.GPSData} for detailsVersion
    gpsBooleanGPS data. See {@linkplain com.smartdevicelink.proxy.rpc.GPSData} for detailsNSubscribableSmartDeviceLink 2.0
    speedBooleanThe vehicle speed in kilometers per hourSmartDeviceLink 2.0
    speedBooleanThe vehicle speed in kilometers per hourNSubscribableSmartDeviceLink 2.0
    rpmBooleanThe number of revolutions per minute of the engineSmartDeviceLink 2.0
    rpmBooleanThe number of revolutions per minute of the engineNSubscribableSmartDeviceLink 2.0
    fuelLevelBooleanThe fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec7.0, please see fuelRange.SmartDeviceLink 2.0
    fuelLevelBooleanThe fuel level in the tank (percentage). This parameter is deprecated starting RPC Spec7.0, please see fuelRange.NSubscribableSmartDeviceLink 7.0.0
    fuelLevel_StateBooleanThe fuel level state. This parameter is deprecated starting RPC Spec 7.0, please see fuelRange.SmartDeviceLink 7.0.0
    fuelLevel_StateBooleanThe fuel level state. This parameter is deprecated starting RPC Spec 7.0, please see fuelRange.NSubscribableSmartDeviceLink 7.0.0
    fuelRangeBooleanThe fuel type, estimated range in KM, fuel level/capacity and fuel level state for the vehicle. See struct FuelRange for details.SmartDeviceLink 7.0.0
    fuelRangeBooleanThe fuel type, estimated range in KM, fuel level/capacity and fuel level state for the vehicle. See struct FuelRange for details.NSubscribableSmartDeviceLink 5.0.0
    instantFuelConsumptionBooleanThe instantaneous fuel consumption in micro litresSmartDeviceLink 5.0.0
    instantFuelConsumptionBooleanThe instantaneous fuel consumption in micro litresNSubscribableSmartDeviceLink 2.0
    externalTemperatureBooleanThe external temperature in degrees celsius. This parameter is deprecated starting RPCSpec 7.1.0, please see climateData.SmartDeviceLink 2.0
    externalTemperatureBooleanThe external temperature in degrees celsius. This parameter is deprecated starting RPCSpec 7.1.0, please see climateData.NSubscribable - * @since SmartDeviceLink 2.0.0 - * @property-deprecated in SmartDeviceLink 7.1.0 - *
    gearStatusBooleanSee GearStatusNSmartDeviceLink 7.0.0
    prndlBooleanSee PRNDL. This parameter is deprecated and it is now covered in `gearStatus`NSmartDeviceLink 7.0.0
    tirePressureBooleanTire pressure status + * @since SmartDeviceLink 2.0.0 + * @property-deprecated in SmartDeviceLink 7.1.0 + *
    gearStatusBooleanSee GearStatusNSmartDeviceLink 7.0.0
    prndlBooleanSee PRNDL. This parameter is deprecated and it is now covered in `gearStatus`NSmartDeviceLink 7.0.0
    tirePressureBooleanTire pressure statusNSubscribableSmartDeviceLink 2.0
    odometerBooleanOdometer in kmSmartDeviceLink 2.0
    odometerBooleanOdometer in kmNMax Length: 500SmartDeviceLink 2.0
    beltStatusBooleanThe status of the seat beltsSmartDeviceLink 2.0
    beltStatusBooleanThe status of the seat beltsNSubscribableSmartDeviceLink 2.0
    bodyInformationBooleanThe body information including ignition status and internal tempNSubscribableSmartDeviceLink 2.0
    bodyInformationBooleanThe body information including ignition status and internal tempSmartDeviceLink 2.0
    deviceStatusBooleanThe device status including signal and battery strengthNSubscribableSmartDeviceLink 2.0
    deviceStatusBooleanThe device status including signal and battery strengthSmartDeviceLink 2.0
    driverBrakingBooleanThe status of the brake pedalNSubscribableSmartDeviceLink 2.0
    driverBrakingBooleanThe status of the brake pedalSmartDeviceLink 2.0
    wiperStatusBooleanThe status of the wipersNSubscribableSmartDeviceLink 2.0
    wiperStatusBooleanThe status of the wipersSmartDeviceLink 2.0
    headLampStatusBooleanStatus of the head lampsNSubscribableSmartDeviceLink 2.0
    headLampStatusBooleanStatus of the head lampsSmartDeviceLink 2.0
    engineTorqueBooleanTorque value for engine (in Nm) on non-diesel variantsNSubscribableSmartDeviceLink 2.0
    engineTorqueBooleanTorque value for engine (in Nm) on non-diesel variantsSmartDeviceLink 2.0
    engineOilLifeBooleanThe estimated percentage of remaining oil life of the engineNSubscribableSmartDeviceLink 2.0
    engineOilLifeBooleanThe estimated percentage of remaining oil life of the engineSmartDeviceLink 5.0
    accPedalPositionBooleanAccelerator pedal position (percentage depressed)NSubscribableSmartDeviceLink 5.0
    accPedalPositionBooleanAccelerator pedal position (percentage depressed)SmartDeviceLink 2.0
    steeringWheelAngleBooleanCurrent angle of the steering wheel (in deg)NSubscribableSmartDeviceLink 2.0
    steeringWheelAngleBooleanCurrent angle of the steering wheel (in deg)SmartDeviceLink 2.0
    eCallInfoBooleanEmergency Call notification and confirmation data.NSubscribableSmartDeviceLink 2.0
    eCallInfoBooleanEmergency Call notification and confirmation data.SmartDeviceLink 2.0
    airbagStatusBooleanThe status of the air bags.NSubscribableSmartDeviceLink 2.0
    airbagStatusBooleanThe status of the air bags.SmartDeviceLink 2.0
    emergencyEventBooleanInformation related to an emergency event (and if it occurred).NSubscribableSmartDeviceLink 2.0
    emergencyEventBooleanInformation related to an emergency event (and if it occurred).SmartDeviceLink 2.0
    clusterModeStatusBooleanThe status modes of the instrument panel cluster.NSubscribableSmartDeviceLink 2.0
    clusterModeStatusBooleanThe status modes of the instrument panel cluster.SmartDeviceLink 2.0
    myKeyBooleanInformation related to the MyKey feature.NSubscribableSmartDeviceLink 2.0
    myKeyBooleanInformation related to the MyKey feature.SmartDeviceLink 2.0
    turnSignalBoolean@see TurnSignalNSubscribableSmartDeviceLink 2.0
    turnSignalBoolean@see TurnSignalNSubscribableSmartDeviceLink 5.0
    SmartDeviceLink 5.0
    handsOffSteeringBooleanNSmartDeviceLink 7.0.0
    stabilityControlsStatusBooleanSee StabilityControlsStatusNSmartDeviceLink 7.0.0
    stabilityControlsStatusBooleanSee StabilityControlsStatusNSmartDeviceLink 7.0.0
    climateDataBoolean
    seatOccupancyBooleanSee SeatOccupancyN - * @since SmartDeviceLink 7.1.0 - *
    seatOccupancyBooleanSee SeatOccupancyN + * @since SmartDeviceLink 7.1.0 + *
    *

    Response

    *

    Non-default Result Codes:

    - *

    SUCCESS

    - *

    WARNINGS

    - *

    INVALID_DATA

    - *

    OUT_OF_MEMORY

    - *

    TOO_MANY_PENDING_REQUESTS

    - *

    APPLICATION_NOT_REGISTERED

    - *

    GENERIC_ERROR

    - *

    IGNORED

    - *

    DISALLOWED

    + *

    SUCCESS

    + *

    WARNINGS

    + *

    INVALID_DATA

    + *

    OUT_OF_MEMORY

    + *

    TOO_MANY_PENDING_REQUESTS

    + *

    APPLICATION_NOT_REGISTERED

    + *

    GENERIC_ERROR

    + *

    IGNORED

    + *

    DISALLOWED

    * * @see SubscribeVehicleData * @see GetVehicleData diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/VehicleDataResult.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/VehicleDataResult.java index 7ca14a25f..5ca1256d9 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/VehicleDataResult.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/VehicleDataResult.java @@ -44,30 +44,30 @@ import java.util.Hashtable; * *

    Parameter List

    * - * - * - * - * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * + * + * + * *
    Param NameTypeDescription
    Param NameTypeDescription Req.NotesVersion Available
    dataTypeVehicleDataTypeDefined published data element type.NotesVersion Available
    dataTypeVehicleDataTypeDefined published data element type.SmartDeviceLink 1.0
    resultCodeVehicleDataResultCodePublished data result code.SmartDeviceLink 1.0
    resultCodeVehicleDataResultCodePublished data result code.SmartDeviceLink 1.0
    SmartDeviceLink 1.0
    */ public class VehicleDataResult extends RPCStruct { diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/VehicleType.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/VehicleType.java index 8841126c3..822114c3c 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/VehicleType.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/VehicleType.java @@ -40,52 +40,52 @@ import java.util.Hashtable; * Describes the type of vehicle the mobile phone is connected with. *

    Parameter List

    * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * *
    NameTypeDescriptionSmartDeviceLink Ver. Available
    makeStringMake of the vehicle - *
      - *
    • Maxlength = 500
      • - *
    - *     		SmartDeviceLink 2.0
    ModelStringModel of the vehicle, e.g. Fiesta - *
      - *
    • Maxlength = 500
      • - *
    - *     		SmartDeviceLink 2.0
    modelYearStringModel Year of the vehicle, e.g. 2013 - *
      - *
    • Maxlength = 500
      • - *
    - *     		SmartDeviceLink 2.0
    trimStringTrim of the vehicle, e.g. SE - *
      - *
    • Maxlength = 500
      • - *
    - *     		SmartDeviceLink 2.0
    NameTypeDescriptionSmartDeviceLink Ver. Available
    makeStringMake of the vehicle + *
      + *
    • Maxlength = 500
      • + *
    + *     		SmartDeviceLink 2.0
    ModelStringModel of the vehicle, e.g. Fiesta + *
      + *
    • Maxlength = 500
      • + *
    + *     		SmartDeviceLink 2.0
    modelYearStringModel Year of the vehicle, e.g. 2013 + *
      + *
    • Maxlength = 500
      • + *
    + *     		SmartDeviceLink 2.0
    trimStringTrim of the vehicle, e.g. SE + *
      + *
    • Maxlength = 500
      • + *
    + *     		SmartDeviceLink 2.0
    * * @since SmartDeviceLink 2.0 diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/VrHelpItem.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/VrHelpItem.java index 6139f66f7..8f6d29bf9 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/VrHelpItem.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/VrHelpItem.java @@ -42,38 +42,38 @@ import java.util.Hashtable; * *

    Parameter List

    * - * - * - * - * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * - * - * - * - * + * + * + * + * + * + * + * * - * - * - * + * + * + * *
    Param NameTypeDescription
    Param NameTypeDescription Req.NotesVersion Available
    textStringText to display for VR Help itemNotesVersion Available
    textStringText to display for VR Help itemYmaxlength: 500SmartDeviceLink 2.3.2
    imageImageImage struct for VR Help itemmaxlength: 500SmartDeviceLink 2.3.2
    imageImageImage struct for VR Help itemNSmartDeviceLink 2.3.2
    positionIntegerPosition to display item in VR Help listSmartDeviceLink 2.3.2
    positionIntegerPosition to display item in VR Help listN minvalue=1; maxvalue=100SmartDeviceLink 2.3.2
    minvalue=1; maxvalue=100SmartDeviceLink 2.3.2
    */ public class VrHelpItem extends RPCStruct { diff --git a/base/src/main/java/com/smartdevicelink/proxy/rpc/enums/SystemCapabilityType.java b/base/src/main/java/com/smartdevicelink/proxy/rpc/enums/SystemCapabilityType.java index e0ff50265..a9f319d66 100644 --- a/base/src/main/java/com/smartdevicelink/proxy/rpc/enums/SystemCapabilityType.java +++ b/base/src/main/java/com/smartdevicelink/proxy/rpc/enums/SystemCapabilityType.java @@ -36,133 +36,133 @@ package com.smartdevicelink.proxy.rpc.enums; * *

    Enum List

    * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * DriverDistractionCapability - * - * - * - * - *
    Enum NameReturn TypeDescriptionRequires Async?Notes
    NAVIGATIONNavigationCapabilityReturns Navigation CapabilitiesYCall is synchronous after initial call
    PHONE_CALLPhoneCapabilityReturns Phone CapabilitiesYCall is synchronous after initial call
    VIDEO_STREAMINGVideoStreamingCapabilityReturns Video Streaming CapabilitiesYCall is synchronous after initial call
    REMOTE_CONTROLRemoteControlCapabilitiesReturns Remote Control CapabilitiesYCall is synchronous after initial call
    HMIHMICapabilitiesReturns HMI CapabilitiesNAvailable Synchronously after Register App Interface response
    DISPLAYDisplayCapabilitiesReturns Display CapabilitiesNAvailable Synchronously after Register App Interface response
    AUDIO_PASSTHROUGHListReturns a List of AudioPassThruCapabilitiesNAvailable Synchronously after Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation
    PCM_STREAMINGAudioPassThruCapabilitiesReturns an AudioPassThruCapabilities ObjectNAvailable Synchronously after Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation
    BUTTONListReturns a List of ButtonCapabilitiesNAvailable Synchronously after Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation
    HMI_ZONEHmiZoneCapabilitiesReturns HmiZone CapabilitiesNAvailable Synchronously after Register App Interface response
    PRESET_BANKPresetBankCapabilitiesReturns PresetBank CapabilitiesNAvailable Synchronously after Register App Interface response
    SOFTBUTTONListReturns a List of SoftButtonCapabilitiesNAvailable Synchronously after Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation
    SPEECHSpeechCapabilitiesReturns Speech CapabilitiesNAvailable Synchronously after Register App Interface response
    VOICE_RECOGNITIONVrCapabilitiesReturns VOICE_RECOGNITIONNAvailable Synchronously after Register App Interface response
    APP_SERVICESAppServicesCapabilitiesReturns APP_SERVICESNAvailable Asynchronously, Call is synchronous after initial call
    SEAT_LOCATIONSeatLocationCapabilityReturns SEAT_LOCATIONNAvailable Asynchronously, Call is synchronous after initial call
    DRIVER_DISTRACTIONReturns DRIVER_DISTRACTIONNSince 7.0 Describes capabilities when the driver is distracted
    + * + * Enum Name + * Return Type + * Description + * Requires Async? + * Notes + * + * + * NAVIGATION + * NavigationCapability + * Returns Navigation Capabilities + * Y + * Call is synchronous after initial call + * + * + * PHONE_CALL + * PhoneCapability + * Returns Phone Capabilities + * Y + * Call is synchronous after initial call + * + * + * VIDEO_STREAMING + * VideoStreamingCapability + * Returns Video Streaming Capabilities + * Y + * Call is synchronous after initial call + * + * + * REMOTE_CONTROL + * RemoteControlCapabilities + * Returns Remote Control Capabilities + * Y + * Call is synchronous after initial call + * + * + * HMI + * HMICapabilities + * Returns HMI Capabilities + * N + * Available Synchronously after Register App Interface response + * + * + * DISPLAY + * DisplayCapabilities + * Returns Display Capabilities + * N + * Available Synchronously after Register App Interface response + * + * + * AUDIO_PASSTHROUGH + * List + * Returns a List of AudioPassThruCapabilities + * N + * Available Synchronously after Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation + * + * + * PCM_STREAMING + * AudioPassThruCapabilities + * Returns an AudioPassThruCapabilities Object + * N + * Available Synchronously after Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation + * + * + * BUTTON + * List + * Returns a List of ButtonCapabilities + * N + * Available Synchronously after Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation + * + * + * HMI_ZONE + * HmiZoneCapabilities + * Returns HmiZone Capabilities + * N + * Available Synchronously after Register App Interface response + * + * + * PRESET_BANK + * PresetBankCapabilities + * Returns PresetBank Capabilities + * N + * Available Synchronously after Register App Interface response + * + * + * SOFTBUTTON + * List + * Returns a List of SoftButtonCapabilities + * N + * Available Synchronously after Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation + * + * + * SPEECH + * SpeechCapabilities + * Returns Speech Capabilities + * N + * Available Synchronously after Register App Interface response + * + * + * VOICE_RECOGNITION + * VrCapabilities + * Returns VOICE_RECOGNITION + * N + * Available Synchronously after Register App Interface response + * + * + * APP_SERVICES + * AppServicesCapabilities + * Returns APP_SERVICES + * N + * Available Asynchronously, Call is synchronous after initial call + * + * + * SEAT_LOCATION + * SeatLocationCapability + * Returns SEAT_LOCATION + * N + * Available Asynchronously, Call is synchronous after initial call + * + * + * DRIVER_DISTRACTION + * DriverDistractionCapability + * Returns DRIVER_DISTRACTION + * N + * Since 7.0 Describes capabilities when the driver is distracted + * + * */ public enum SystemCapabilityType { @@ -170,82 +170,82 @@ public enum SystemCapabilityType { /** * Requires initial asynchronous call, then available synchronously after successful call.
    * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
    Enum NameReturn TypeDescriptionRequires Async?Notes
    NAVIGATIONNavigationCapabilityReturns Navigation CapabilitiesYCall is synchronous after initial call
    + * + * Enum Name + * Return Type + * Description + * Requires Async? + * Notes + * + * + * NAVIGATION + * NavigationCapability + * Returns Navigation Capabilities + * Y + * Call is synchronous after initial call + * + * */ NAVIGATION(true), /** * Requires initial asynchronous call, then available synchronously after successful call.
    * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
    Enum NameReturn TypeDescriptionRequires Async?Notes
    PHONE_CALLPhoneCapabilityReturns Phone CapabilitiesYCall is synchronous after initial call
    + * + * Enum Name + * Return Type + * Description + * Requires Async? + * Notes + * + * + * PHONE_CALL + * PhoneCapability + * Returns Phone Capabilities + * Y + * Call is synchronous after initial call + * + * */ PHONE_CALL(true), /** * Requires initial asynchronous call, then available synchronously after successful call.
    * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
    Enum NameReturn TypeDescriptionRequires Async?Notes
    VIDEO_STREAMINGVideoStreamingCapabilityReturns Video Streaming CapabilitiesYCall is synchronous after initial call
    + * + * Enum Name + * Return Type + * Description + * Requires Async? + * Notes + * + * + * VIDEO_STREAMING + * VideoStreamingCapability + * Returns Video Streaming Capabilities + * Y + * Call is synchronous after initial call + * + * */ VIDEO_STREAMING(true), /** * Requires initial asynchronous call, then available synchronously after successful call.
    * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * *
    Enum NameReturn TypeDescriptionRequires Async?Notes
    REMOTE_CONTROLRemoteControlCapabilitiesReturns Remote Control CapabilitiesYCall is synchronous after initial call
    Enum NameReturn TypeDescriptionRequires Async?Notes
    REMOTE_CONTROLRemoteControlCapabilitiesReturns Remote Control CapabilitiesYCall is synchronous after initial call
    */ REMOTE_CONTROL(true), @@ -255,20 +255,20 @@ public enum SystemCapabilityType { /** * Available Synchronously after Register App Interface response
    * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * *
    Enum NameReturn TypeDescriptionRequires Async?Notes
    HMIHMICapabilitiesReturns HMI CapabilitiesNAvailable Synchronously after Register App Interface response
    Enum NameReturn TypeDescriptionRequires Async?Notes
    HMIHMICapabilitiesReturns HMI CapabilitiesNAvailable Synchronously after Register App Interface response
    */ HMI(false), @@ -277,21 +277,21 @@ public enum SystemCapabilityType { * Available Synchronously after Register App Interface response
    * Returns: DisplayCapabilities * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
    Enum NameReturn TypeDescriptionRequires Async?Notes
    DISPLAYDisplayCapabilitiesReturns Display CapabilitiesN Available Synchronously after Register App Interface response received
    + * + * Enum Name + * Return Type + * Description + * Requires Async? + * Notes + * + * + * DISPLAY + * DisplayCapabilities + * Returns Display Capabilities + * N + * Available Synchronously after Register App Interface response received + * + * */ @Deprecated DISPLAY(false), @@ -301,21 +301,21 @@ public enum SystemCapabilityType { * @since 6.0 * Returns: List * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
    Enum NameReturn TypeDescriptionRequires Async?Notes
    DISPLAYSListReturns a list of Display CapabilityY Since 6.0 Contain the display related information and all windows related to that display.
    + * + * Enum Name + * Return Type + * Description + * Requires Async? + * Notes + * + * + * DISPLAYS + * List + * Returns a list of Display Capability + * Y + * Since 6.0 Contain the display related information and all windows related to that display. + * + * */ DISPLAYS(true), @@ -323,21 +323,21 @@ public enum SystemCapabilityType { * Available Synchronously after Register App Interface response
    * Returns: List * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
    Enum NameReturn TypeDescriptionRequires Async?Notes
    PRERECORDED_SPEECHprerecordedSpeechCapabilitiesReturns ListNAvailable Synchronously after Register App Interface response received
    + * + * Enum Name + * Return Type + * Description + * Requires Async? + * Notes + * + * + * PRERECORDED_SPEECH + * prerecordedSpeechCapabilities + * Returns List + * N + * Available Synchronously after Register App Interface response received + * + * */ PRERECORDED_SPEECH(false), @@ -345,21 +345,21 @@ public enum SystemCapabilityType { * Available Synchronously after Register App Interface response
    * Note: @SuppressWarnings("unchecked") may be needed when casting depending on implementation * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
    Enum NameReturn TypeDescriptionRequires Async?Notes
    AUDIO_PASSTHROUGHListReturns a List of AudioPassThruCapabilitiesNAvailable Synchronously after Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation
    + * + * Enum Name + * Return Type + * Description + * Requires Async? + * Notes + * + * + * AUDIO_PASSTHROUGH + * List + * Returns a List of AudioPassThruCapabilities + * N + * Available Synchronously after Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation + * + * */ AUDIO_PASSTHROUGH(false), @@ -367,21 +367,21 @@ public enum SystemCapabilityType { * Available Synchronously after Register App Interface response
    * Note: @SuppressWarnings("unchecked") may be needed when casting depending on implementation * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
    Enum NameReturn TypeDescriptionRequires Async?Notes
    PCM_STREAMINGAudioPassThruCapabilitiesReturns a AudioPassThruCapabilities ObjectNAvailable Synchronously after Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation
    + * + * Enum Name + * Return Type + * Description + * Requires Async? + * Notes + * + * + * PCM_STREAMING + * AudioPassThruCapabilities + * Returns a AudioPassThruCapabilities Object + * N + * Available Synchronously after Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation + * + * */ PCM_STREAMING(false), @@ -389,21 +389,21 @@ public enum SystemCapabilityType { * Available Synchronously after Register App Interface response
    * Note: @SuppressWarnings("unchecked") may be needed when casting depending on implementation * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
    Enum NameReturn TypeDescriptionRequires Async?Notes
    BUTTONListReturns a List of ButtonCapabilitiesNAvailable Synchronously after Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation
    + * + * Enum Name + * Return Type + * Description + * Requires Async? + * Notes + * + * + * BUTTON + * List + * Returns a List of ButtonCapabilities + * N + * Available Synchronously after Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation + * + * */ @Deprecated BUTTON(false), @@ -411,42 +411,42 @@ public enum SystemCapabilityType { /** * Available Synchronously after Register App Interface response
    * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
    Enum NameReturn TypeDescriptionRequires Async?Notes
    HMI_ZONEHmiZoneCapabilitiesReturns HmiZone CapabilitiesNAvailable Synchronously after Register App Interface response
    + * + * Enum Name + * Return Type + * Description + * Requires Async? + * Notes + * + * + * HMI_ZONE + * HmiZoneCapabilities + * Returns HmiZone Capabilities + * N + * Available Synchronously after Register App Interface response + * + * */ HMI_ZONE(false), /** * Available Synchronously after Register App Interface response
    * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
    Enum NameReturn TypeDescriptionRequires Async?Notes
    PRESET_BANKPresetBankCapabilitiesReturns PresetBank CapabilitiesNAvailable Synchronously after Register App Interface response
    + * + * Enum Name + * Return Type + * Description + * Requires Async? + * Notes + * + * + * PRESET_BANK + * PresetBankCapabilities + * Returns PresetBank Capabilities + * N + * Available Synchronously after Register App Interface response + * + * */ @Deprecated PRESET_BANK(false), @@ -456,21 +456,21 @@ public enum SystemCapabilityType { * Returns: List
    * Note: @SuppressWarnings("unchecked") may be needed when casting depending on implementation * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
    Enum NameReturn TypeDescriptionRequires Async?Notes
    SOFTBUTTONListReturns a List of SoftButtonCapabilitiesNAvailable Synchronously after Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation
    + * + * Enum Name + * Return Type + * Description + * Requires Async? + * Notes + * + * + * SOFTBUTTON + * List + * Returns a List of SoftButtonCapabilities + * N + * Available Synchronously after Register App Interface response. @SuppressWarnings("unchecked") may be needed when casting depending on implementation + * + * */ @Deprecated SOFTBUTTON(false), @@ -478,102 +478,102 @@ public enum SystemCapabilityType { /** * Available Synchronously after Register App Interface response
    * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
    Enum NameReturn TypeDescriptionRequires Async?Notes
    SPEECHSpeechCapabilitiesReturns Speech CapabilitiesNAvailable Synchronously after Register App Interface response
    + * + * Enum Name + * Return Type + * Description + * Requires Async? + * Notes + * + * + * SPEECH + * SpeechCapabilities + * Returns Speech Capabilities + * N + * Available Synchronously after Register App Interface response + * + * */ SPEECH(false), /** * Available Synchronously after Register App Interface response
    * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
    Enum NameReturn TypeDescriptionRequires Async?Notes
    VOICE_RECOGNITIONVrCapabilitiesReturns VOICE_RECOGNITIONNAvailable Synchronously after Register App Interface response
    + * + * Enum Name + * Return Type + * Description + * Requires Async? + * Notes + * + * + * VOICE_RECOGNITION + * VrCapabilities + * Returns VOICE_RECOGNITION + * N + * Available Synchronously after Register App Interface response + * + * */ VOICE_RECOGNITION(false), /** * Available Synchronously after Register App Interface response
    * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
    Enum NameReturn TypeDescriptionRequires Async?Notes
    APP_SERVICESAppServicesCapabilitiesReturns APP_SERVICESNAvailable Asynchronously, Call is synchronous after initial call
    + * + * Enum Name + * Return Type + * Description + * Requires Async? + * Notes + * + * + * APP_SERVICES + * AppServicesCapabilities + * Returns APP_SERVICES + * N + * Available Asynchronously, Call is synchronous after initial call + * + * */ APP_SERVICES(true), /** * Available Synchronously after Register App Interface response
    * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
    Enum NameReturn TypeDescriptionRequires Async?Notes
    SEAT_LOCATIONSeatLocationCapabilityReturns SEAT_LOCATIONNAvailable Asynchronously, Call is synchronous after initial call
    + * + * Enum Name + * Return Type + * Description + * Requires Async? + * Notes + * + * + * SEAT_LOCATION + * SeatLocationCapability + * Returns SEAT_LOCATION + * N + * Available Asynchronously, Call is synchronous after initial call + * + * */ SEAT_LOCATION(true), /** * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
    Enum NameReturn TypeDescriptionRequires Async?Notes
    DRIVER_DISTRACTIONDriverDistractionCapabilityReturns DRIVER_DISTRACTIONNSince 7.0 Describes capabilities when the driver is distracted
    + * + * Enum Name + * Return Type + * Description + * Requires Async? + * Notes + * + * + * DRIVER_DISTRACTION + * DriverDistractionCapability + * Returns DRIVER_DISTRACTION + * N + * Since 7.0 Describes capabilities when the driver is distracted + * + * */ DRIVER_DISTRACTION(true); diff --git a/base/src/main/java/com/smartdevicelink/streaming/video/VideoStreamingParameters.java b/base/src/main/java/com/smartdevicelink/streaming/video/VideoStreamingParameters.java index 7a2fe7b78..20d79bc45 100644 --- a/base/src/main/java/com/smartdevicelink/streaming/video/VideoStreamingParameters.java +++ b/base/src/main/java/com/smartdevicelink/streaming/video/VideoStreamingParameters.java @@ -98,13 +98,13 @@ public class VideoStreamingParameters { @Deprecated public VideoStreamingParameters(int displayDensity, int frameRate, int bitrate, int interval, ImageResolution resolution, VideoStreamingFormat format) { - this.displayDensity = displayDensity; - this.frameRate = frameRate; - this.bitrate = bitrate; - this.interval = interval; - this.resolution = resolution; - this.format = format; - this.stableFrameRate = true; + this.displayDensity = displayDensity; + this.frameRate = frameRate; + this.bitrate = bitrate; + this.interval = interval; + this.resolution = resolution; + this.format = format; + this.stableFrameRate = true; } /** @@ -178,7 +178,7 @@ public class VideoStreamingParameters { if (!params.additionalCapabilities.isEmpty()) { this.additionalCapabilities = params.additionalCapabilities; } - this.stableFrameRate = params.stableFrameRate; + this.stableFrameRate = params.stableFrameRate; } } @@ -304,13 +304,13 @@ public class VideoStreamingParameters { return resolution; } - public boolean isStableFrameRate() { - return stableFrameRate; - } + public boolean isStableFrameRate() { + return stableFrameRate; + } - public void setStableFrameRate(boolean isStable) { - stableFrameRate = isStable; - } + public void setStableFrameRate(boolean isStable) { + stableFrameRate = isStable; + } public double getScale() { return scale; } diff --git a/base/src/main/java/com/smartdevicelink/transport/SdlPsm.java b/base/src/main/java/com/smartdevicelink/transport/SdlPsm.java index dc8fd3bbc..e60cdde35 100644 --- a/base/src/main/java/com/smartdevicelink/transport/SdlPsm.java +++ b/base/src/main/java/com/smartdevicelink/transport/SdlPsm.java @@ -133,11 +133,11 @@ public class SdlPsm { //Log.trace(TAG,"Frame Info: " + controlFrameInfo); switch (frameType) { case SdlPacket.FRAME_TYPE_CONTROL: - /*if(frameInfoFRAME_INFO_END_SERVICE_ACK - && (frameInfo!=FRAME_INFO_SERVICE_DATA_ACK || frameInfo!=FRAME_INFO_HEART_BEAT_ACK))){ - return ERROR_STATE; - }*/ //Although some bits are reserved...whatever + /*if(frameInfoFRAME_INFO_END_SERVICE_ACK + && (frameInfo!=FRAME_INFO_SERVICE_DATA_ACK || frameInfo!=FRAME_INFO_HEART_BEAT_ACK))){ + return ERROR_STATE; + }*/ //Although some bits are reserved...whatever break; case SdlPacket.FRAME_TYPE_SINGLE: //Fall through since they are both the same case SdlPacket.FRAME_TYPE_FIRST: diff --git a/base/src/main/java/com/smartdevicelink/transport/SiphonServer.java b/base/src/main/java/com/smartdevicelink/transport/SiphonServer.java index 39871b777..13c20370a 100644 --- a/base/src/main/java/com/smartdevicelink/transport/SiphonServer.java +++ b/base/src/main/java/com/smartdevicelink/transport/SiphonServer.java @@ -292,7 +292,7 @@ public class SiphonServer { try { // blobSize = length(of message) + 1(size of direction indicator) - // + 1 (size of msgVersionNumber) + 4 (size of timeStamp) + // + 1 (size of msgVersionNumber) + 4 (size of timeStamp) int blobSize = length + 1 + 1 + 4; siphonOutputStream.write(BitConverter.intToByteArray(blobSize)); -- cgit v1.2.1